com.marklogic.mapreduce.functions
Class ValueCooccurrences

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

public abstract class ValueCooccurrences
extends CooccurrencesFunction

Wrapper class for the cts: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

ValueCooccurrences()

Method Summary

abstract Reference	getReference1() Get the value for $range-index-1 parameter to the lexicon function call, as a reference.
abstract Reference	getReference2() Get the value for $range-index-2 parameter to the lexicon function call, as a reference.

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

ValueCooccurrences

public ValueCooccurrences()

Method Detail

getReference1

public abstract Reference getReference1()

Get the value for $range-index-1 parameter to the lexicon function call, as a reference.

Returns:

first range index reference.

getReference2

public abstract Reference getReference2()

Get the value for $range-index-2 parameter to the lexicon function call, as a reference.

Returns:

second range index reference.