com.marklogic.mapreduce.functions
Class ElementWordMatch

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

public abstract class ElementWordMatch
extends ValueOrWordMatchFunction

Wrapper class for the cts:element-word-match lexicon function. Subclass this class to generate map input based on a lexicon.

Use this class with ValueInputFormat.

To generate map input using the lexicon function, create a subclass of this class and provide implementations of the methods that correspond to the function parameters you want to include in the call.

For details, see "Using a Lexicon to Generate Key-Value Pairs" in the MarkLogic Connector for Hadoop Developer's Guide.

Constructor Summary

ElementWordMatch()

Method Summary

abstract String[]

getElementNames() Get the value of the $element-names parameter to the lexicon function call, as an array of element QName strings.

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

getInputQuery, getPattern

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

ElementWordMatch

public ElementWordMatch()

Method Detail

getElementNames

public abstract String[] getElementNames()

Get the value of the $element-names parameter to the lexicon function call, as an array of element QName strings.

Each string in the array must evaluate to an xs:QName when evaluated as XQuery. For example: "xs:QName(\"wp:a\")".

Returns:

an array of element QNames.