com.marklogic.mapreduce.functions
Class FieldValueCooccurrences

java.lang.Object
  com.marklogic.mapreduce.functions.LexiconFunction
      com.marklogic.mapreduce.functions.CooccurrencesFunction
          com.marklogic.mapreduce.functions.FieldValueCooccurrences

public abstract class FieldValueCooccurrences
extends CooccurrencesFunction

Wrapper class for the cts:field-value-co-occurrences lexicon function. Subclass this class to generate map input based on a lexicon.

Use this class with KeyValueInputFormat or ValueInputFormat.

To generate map input with 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.

All co-occurrences functions using this API do NOT preserve frequency order even if "frequency-order" option is specified.

Constructor Summary

FieldValueCooccurrences()

Method Summary

abstract String	getFieldName1() Get the value for the $field-name-1 parameter to the lexicon function call, as a string.
abstract String	getFieldName2() Get the value for the $field-name-2 parameter to the lexicon function call, as a string.

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

getInputQuery

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

FieldValueCooccurrences

public FieldValueCooccurrences()

Method Detail

getFieldName1

public abstract String getFieldName1()

Get the value for the $field-name-1 parameter to the lexicon function call, as a string. The string should result in an xs:QName when evaluated as XQuery.

Returns:

first element QName.

getFieldName2

public abstract String getFieldName2()

Get the value for the $field-name-2 parameter to the lexicon function call, as a string. The string should result in an xs:QName when evaluated as XQuery.

Returns:

first element QName.