com.exalead.indexing.analysis.v10

Class IncreaseRankOnAnnotation

java.lang.Object

com.exalead.indexing.analysis.v10.IncreaseRankOnAnnotation

All Implemented Interfaces:

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

public class IncreaseRankOnAnnotation
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Allows you to increase the ranking when some words are flagged by an annotation (part of speech, ontology, ...).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotationName
java.lang.String	annotationValue
int	value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IncreaseRankOnAnnotation.
static IncreaseRankOnAnnotation	fromString(java.lang.String s) String representation of this IncreaseRankOnAnnotation.
java.lang.String	getAnnotationName() Name of the targeted annotation.
java.lang.String	getAnnotationValue() Value of the annotation that will trigger the increase in ranking.
int	getValue() Number to increase in the ranking when triggered.
IncreaseRankOnAnnotation	makeCopy() Creates and returns a deep copy of this IncreaseRankOnAnnotation.
static IncreaseRankOnAnnotation	readFrom(java.io.InputStream is) Read this IncreaseRankOnAnnotation from an XML fragment.
void	setAnnotationName(java.lang.String annotationName) Name of the targeted annotation.
void	setAnnotationValue(java.lang.String annotationValue) Value of the annotation that will trigger the increase in ranking.
void	setValue(int value) Number to increase in the ranking when triggered.
java.lang.String	toString() String representation of this IncreaseRankOnAnnotation.
IncreaseRankOnAnnotation	withAnnotationName(java.lang.String annotationName)
IncreaseRankOnAnnotation	withAnnotationValue(java.lang.String annotationValue)
IncreaseRankOnAnnotation	withValue(int value)
IncreaseRankOnAnnotation	withValue(java.lang.Integer value)
void	writeTo(java.io.OutputStream os) Write this IncreaseRankOnAnnotation as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

annotationName

public java.lang.String annotationName

annotationValue

public java.lang.String annotationValue

value

public int value

Constructor Detail

IncreaseRankOnAnnotation

public IncreaseRankOnAnnotation()

IncreaseRankOnAnnotation

public IncreaseRankOnAnnotation(IncreaseRankOnAnnotation o)

Copy constructor

Method Detail

setAnnotationName

public void setAnnotationName(java.lang.String annotationName)

Name of the targeted annotation.

getAnnotationName

public java.lang.String getAnnotationName()

Name of the targeted annotation.

withAnnotationName

public IncreaseRankOnAnnotation withAnnotationName(java.lang.String annotationName)

setAnnotationValue

public void setAnnotationValue(java.lang.String annotationValue)

Value of the annotation that will trigger the increase in ranking.

getAnnotationValue

public java.lang.String getAnnotationValue()

Value of the annotation that will trigger the increase in ranking.

withAnnotationValue

public IncreaseRankOnAnnotation withAnnotationValue(java.lang.String annotationValue)

setValue

public void setValue(int value)

Number to increase in the ranking when triggered.

getValue

public int getValue()

Number to increase in the ranking when triggered.

withValue

public IncreaseRankOnAnnotation withValue(int value)

withValue

public IncreaseRankOnAnnotation withValue(java.lang.Integer value)

makeCopy

public IncreaseRankOnAnnotation makeCopy()

Creates and returns a deep copy of this IncreaseRankOnAnnotation.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IncreaseRankOnAnnotation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IncreaseRankOnAnnotation.

Overrides:

toString in class java.lang.Object

check

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

Checks this IncreaseRankOnAnnotation.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException