com.marklogic.mapreduce.functions

Class ElemAttrValueCooccurrences

java.lang.Object

com.marklogic.mapreduce.functions.LexiconFunction

com.marklogic.mapreduce.functions.CooccurrencesFunction

com.marklogic.mapreduce.functions.ElemAttrValueCooccurrences

public abstract class ElemAttrValueCooccurrences
extends CooccurrencesFunction

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

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

Constructor Summary

Constructors

Constructor and Description
ElemAttrValueCooccurrences()

Method Summary

Modifier and Type	Method and Description
String	getAttributeName1() Get the value for the $attribute-name-1 parameter to the lexicon function call, as a string.
String	getAttributeName2() Get the value for the $attribute-name-2 parameter to the lexicon function call, as a string.
abstract String	getElementName1() Get the value for the $element-name-1 parameter to the lexicon function call, as a string.
abstract String	getElementName2() Get the value for the $element-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

ElemAttrValueCooccurrences

public ElemAttrValueCooccurrences()

Method Detail

getElementName1

public abstract String getElementName1()

Get the value for the $element-name-1 parameter to the lexicon function call, as a string. The returned string must evaluate to an xs:QName when evaluated as XQuery. For example: "xs:QName(\"wp:a\")".

Returns:

first element QName.

getAttributeName1

public String getAttributeName1()

Get the value for the $attribute-name-1 parameter to the lexicon function call, as a string.

The returned string must evaluate to an xs:QName when evaluated as XQuery. For example: "xs:QName(\"wp:a\")". Returning the empty sequence ("()") specifies an element sequence.

Returns:

second attribute QName.

getElementName2

public abstract String getElementName2()

Get the value for the $element-name-2 parameter to the lexicon function call, as a string. The returned string must evaluate to an xs:QName when evaluated as XQuery For example: "xs:QName(\"wp:a\")".

Returns:

second element QName.

getAttributeName2

public String getAttributeName2()

Get the value for the $attribute-name-2 parameter to the lexicon function call, as a string.

The returned string must evaluate to an xs:QName when evaluated as XQuery. For example: "xs:QName(\"wp:a\")". Returning the empty sequence ("()") specifies an element sequence.

Returns:

second attribute QName.