com.exalead.linguistic.v10

Class SelectMostFrequentValue

java.lang.Object

com.exalead.linguistic.v10.AnnotationManagerOperation

com.exalead.linguistic.v10.SelectMostFrequentValue

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class SelectMostFrequentValue
extends AnnotationManagerOperation
implements com.exalead.util.Checkable, java.io.Serializable

Selects the N most frequent values of a given annotation and annotates the document with them

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
static int	DEFAULT_HOW_MANY
static boolean	DEFAULT_TRUNCATE
java.lang.String	documentAnnotation
int	howMany
boolean	truncate

Constructor Summary

Constructors

Constructor and Description
SelectMostFrequentValue()
SelectMostFrequentValue(SelectMostFrequentValue o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SelectMostFrequentValue.
static SelectMostFrequentValue	fromString(java.lang.String s) String representation of this SelectMostFrequentValue.
java.lang.String	getAnnotation() The annotation to find
java.lang.String	getDocumentAnnotation() Annotates the document with this annotation instead of the selected annotation
int	getHowMany() How many values should be kept
boolean	isTruncate() Keeps only one value when there are multiple candidates
SelectMostFrequentValue	makeCopy() Creates and returns a deep copy of this SelectMostFrequentValue.
static SelectMostFrequentValue	readFrom(java.io.InputStream is) Read this SelectMostFrequentValue from an XML fragment.
void	setAnnotation(java.lang.String annotation) The annotation to find
void	setDocumentAnnotation(java.lang.String documentAnnotation) Annotates the document with this annotation instead of the selected annotation
void	setHowMany(int howMany) How many values should be kept
void	setTruncate(boolean truncate) Keeps only one value when there are multiple candidates
java.lang.String	toString() String representation of this SelectMostFrequentValue.
SelectMostFrequentValue	withAnnotation(java.lang.String annotation)
SelectMostFrequentValue	withDocumentAnnotation(java.lang.String documentAnnotation)
SelectMostFrequentValue	withHowMany(int howMany)
SelectMostFrequentValue	withHowMany(java.lang.Integer howMany)
SelectMostFrequentValue	withTruncate(boolean truncate)
SelectMostFrequentValue	withTruncate(java.lang.Boolean truncate)
void	writeTo(java.io.OutputStream os) Write this SelectMostFrequentValue as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

annotation

public java.lang.String annotation

documentAnnotation

public java.lang.String documentAnnotation

truncate

public boolean truncate

DEFAULT_TRUNCATE

public static final boolean DEFAULT_TRUNCATE

See Also:

Constant Field Values

howMany

public int howMany

DEFAULT_HOW_MANY

public static final int DEFAULT_HOW_MANY

See Also:

Constant Field Values

Constructor Detail

SelectMostFrequentValue

public SelectMostFrequentValue()

SelectMostFrequentValue

public SelectMostFrequentValue(SelectMostFrequentValue o)

Copy constructor

Method Detail

setAnnotation

public void setAnnotation(java.lang.String annotation)

The annotation to find

getAnnotation

public java.lang.String getAnnotation()

The annotation to find

withAnnotation

public SelectMostFrequentValue withAnnotation(java.lang.String annotation)

setDocumentAnnotation

public void setDocumentAnnotation(java.lang.String documentAnnotation)

Annotates the document with this annotation instead of the selected annotation

getDocumentAnnotation

public java.lang.String getDocumentAnnotation()

Annotates the document with this annotation instead of the selected annotation

withDocumentAnnotation

public SelectMostFrequentValue withDocumentAnnotation(java.lang.String documentAnnotation)

setTruncate

public void setTruncate(boolean truncate)

Keeps only one value when there are multiple candidates

isTruncate

public boolean isTruncate()

Keeps only one value when there are multiple candidates

withTruncate

public SelectMostFrequentValue withTruncate(boolean truncate)

withTruncate

public SelectMostFrequentValue withTruncate(java.lang.Boolean truncate)

setHowMany

public void setHowMany(int howMany)

How many values should be kept

getHowMany

public int getHowMany()

How many values should be kept

withHowMany

public SelectMostFrequentValue withHowMany(int howMany)

withHowMany

public SelectMostFrequentValue withHowMany(java.lang.Integer howMany)

makeCopy

public SelectMostFrequentValue makeCopy()

Creates and returns a deep copy of this SelectMostFrequentValue.

Overrides:

makeCopy in class AnnotationManagerOperation

readFrom

public static SelectMostFrequentValue readFrom(java.io.InputStream is)
                                        throws javax.xml.bind.JAXBException

Read this SelectMostFrequentValue from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this SelectMostFrequentValue as an XML fragment

Overrides:

writeTo in class AnnotationManagerOperation

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static SelectMostFrequentValue fromString(java.lang.String s)
                                          throws javax.xml.bind.JAXBException,
                                                 java.io.UnsupportedEncodingException

String representation of this SelectMostFrequentValue.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SelectMostFrequentValue.

Overrides:

toString in class AnnotationManagerOperation

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this SelectMostFrequentValue.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AnnotationManagerOperation

Throws:

com.exalead.util.TypedException