com.marklogic.mapreduce.functions
Class PathReference

java.lang.Object
  com.marklogic.mapreduce.functions.Reference
      com.marklogic.mapreduce.functions.PathReference

public abstract class PathReference
extends Reference

Wrapper class for the cts:path-reference function. This class represents a reference to a path value lexicon (path range index).

Constructor Summary

PathReference()

Method Summary

void	append(StringBuilder buf)
abstract String	getPathExpression() The path range expression represented by this lexicon.
String[]	getUserDefinedOptions() Get user-defined options for the path reference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathReference

public PathReference()

Method Detail

append

public void append(StringBuilder buf)

Specified by:

append in class Reference

getPathExpression

public abstract String getPathExpression()

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:

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-reference in the XQuery and XSLT Reference.