com.marklogic.mapreduce.functions
Class FieldWords

java.lang.Object
  com.marklogic.mapreduce.functions.LexiconFunction
      com.marklogic.mapreduce.functions.ValuesOrWordsFunction
          com.marklogic.mapreduce.functions.FieldWords

public abstract class FieldWords
extends ValuesOrWordsFunction

Wrapper class for the cts:field-words 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. For an example, see LinkCountCooccurrences.

Constructor Summary

FieldWords()

Method Summary

abstract String[]

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

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

getInputQuery, getStart

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

FieldWords

public FieldWords()

Method Detail

getFieldNames

public abstract String[] getFieldNames()

Get the value of the $field-names parameter to the lexicon function call, as an array of strings. Each string should be a field name.

Returns:

an array of element QNames.