com.marklogic.mapreduce.functions
Class ValueOrWordMatchFunction

java.lang.Object
  com.marklogic.mapreduce.functions.LexiconFunction
      com.marklogic.mapreduce.functions.ValueOrWordMatchFunction

Direct Known Subclasses:

CollectionMatch, ElementAttributeValueMatch, ElementAttributeWordMatch, ElementValueMatch, ElementWordMatch, FieldValueMatch, FieldWordMatch, UriMatch, ValueMatch, WordMatch

public abstract class ValueOrWordMatchFunction
extends LexiconFunction

Super class for wrapper classes for lexicon word and value match functions, such as cts:element-value-match or cts:field-word-match.

Constructor Summary

ValueOrWordMatchFunction()

Method Summary

String	getInputQuery(Collection<String> nsCol, long start, long count) Get the input query used by a record reader.
String	getPattern() Get the value for the $pattern parameter to a lexicon function call.

Methods inherited from class com.marklogic.mapreduce.functions.LexiconFunction

getLexiconQuery, getUserDefinedOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueOrWordMatchFunction

public ValueOrWordMatchFunction()

Method Detail

getPattern

public String getPattern()

Get the value for the $pattern parameter to a lexicon function call.

This method corresponds to the $pattern parameter value of a lexicon function call. Override this function to supply a pattern other than the default.

When evaluated as XQuery, the returned string must resolve to an atomic type matching the type of the lexicon. String patterns may include wildcard characters.

Returns:

the pattern to match.

getInputQuery

public String getInputQuery(Collection<String> nsCol,
                            long start,
                            long count)

Description copied from class: LexiconFunction

Get the input query used by a record reader. Users must not override this method.

Specified by:

getInputQuery in class LexiconFunction

Parameters:

nsCol - alias-URI pairs of namespace specs

start - start of the split

count - count of the split

Returns:

input query.