Class PathReference
- java.lang.Object
-
- com.marklogic.mapreduce.functions.Reference
-
- com.marklogic.mapreduce.functions.PathReference
-
public abstract class PathReference extends Reference
Wrapper class for thects:path-referencefunction. This class represents a reference to a path value lexicon (path range index).
-
-
Constructor Summary
Constructors Constructor Description PathReference()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidappend(StringBuilder buf)abstract StringgetPathExpression()Get the path range expression represented by this lexicon.String[]getUserDefinedOptions()Get user-defined options for the path reference.
-
-
-
Method Detail
-
append
public void append(StringBuilder buf)
-
getPathExpression
public abstract String getPathExpression()
Get the path range expression represented by this lexicon.This path expression must correspond to the path expression used to create an existing path range index.
- Returns:
- A path range expression.
-
getUserDefinedOptions
public String[] getUserDefinedOptions()
Get user-defined options for the path reference.This method corresponds to the $options parameter of the path reference function. Override this method to pass options to the path reference function. For a list of available options, see
cts:path-referencein the XQuery and XSLT Reference.
-
-