com.exalead.linguistic.v10

Class SelectByContexts

java.lang.Object

com.exalead.linguistic.v10.AnnotationManagerOperation

com.exalead.linguistic.v10.SelectByContexts

All Implemented Interfaces:

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

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

Selects annotations appearing in the first context of a list sorted by decreasing priority.
For example, selecting an annotation from (title, text) will lookup title context and then, if the annotation is not found, text context.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
java.lang.String	contexts
static boolean	DEFAULT_FIRST_ONLY
java.lang.String	documentAnnotation
boolean	firstOnly

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SelectByContexts.
static SelectByContexts	fromString(java.lang.String s) String representation of this SelectByContexts.
java.lang.String	getAnnotation() The annotation to find
java.lang.String	getContexts() The contexts to select the annotation from, sorted by decreasing priority
java.lang.String	getDocumentAnnotation() Annotates the document with this annotation
boolean	isFirstOnly() Selects only the first occurrence of the annotation
SelectByContexts	makeCopy() Creates and returns a deep copy of this SelectByContexts.
static SelectByContexts	readFrom(java.io.InputStream is) Read this SelectByContexts from an XML fragment.
void	setAnnotation(java.lang.String annotation) The annotation to find
void	setContexts(java.lang.String contexts) The contexts to select the annotation from, sorted by decreasing priority
void	setDocumentAnnotation(java.lang.String documentAnnotation) Annotates the document with this annotation
void	setFirstOnly(boolean firstOnly) Selects only the first occurrence of the annotation
java.lang.String	toString() String representation of this SelectByContexts.
SelectByContexts	withAnnotation(java.lang.String annotation)
SelectByContexts	withContexts(java.lang.String contexts)
SelectByContexts	withDocumentAnnotation(java.lang.String documentAnnotation)
SelectByContexts	withFirstOnly(boolean firstOnly)
SelectByContexts	withFirstOnly(java.lang.Boolean firstOnly)
void	writeTo(java.io.OutputStream os) Write this SelectByContexts 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

contexts

public java.lang.String contexts

documentAnnotation

public java.lang.String documentAnnotation

firstOnly

public boolean firstOnly

DEFAULT_FIRST_ONLY

public static final boolean DEFAULT_FIRST_ONLY

See Also:

Constant Field Values

Constructor Detail

SelectByContexts

public SelectByContexts()

SelectByContexts

public SelectByContexts(SelectByContexts 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 SelectByContexts withAnnotation(java.lang.String annotation)

setContexts

public void setContexts(java.lang.String contexts)

The contexts to select the annotation from, sorted by decreasing priority

getContexts

public java.lang.String getContexts()

The contexts to select the annotation from, sorted by decreasing priority

withContexts

public SelectByContexts withContexts(java.lang.String contexts)

setDocumentAnnotation

public void setDocumentAnnotation(java.lang.String documentAnnotation)

Annotates the document with this annotation

getDocumentAnnotation

public java.lang.String getDocumentAnnotation()

Annotates the document with this annotation

withDocumentAnnotation

public SelectByContexts withDocumentAnnotation(java.lang.String documentAnnotation)

setFirstOnly

public void setFirstOnly(boolean firstOnly)

Selects only the first occurrence of the annotation

isFirstOnly

public boolean isFirstOnly()

Selects only the first occurrence of the annotation

withFirstOnly

public SelectByContexts withFirstOnly(boolean firstOnly)

withFirstOnly

public SelectByContexts withFirstOnly(java.lang.Boolean firstOnly)

makeCopy

public SelectByContexts makeCopy()

Creates and returns a deep copy of this SelectByContexts.

Overrides:

makeCopy in class AnnotationManagerOperation

readFrom

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

Read this SelectByContexts 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 SelectByContexts as an XML fragment

Overrides:

writeTo in class AnnotationManagerOperation

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SelectByContexts.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SelectByContexts.

Overrides:

toString in class AnnotationManagerOperation

check

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

Checks this SelectByContexts.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AnnotationManagerOperation

Throws:

com.exalead.util.TypedException