com.exalead.indexing.analysis.v10

Class DecreaseRankOnAnnotation

java.lang.Object

com.exalead.indexing.analysis.v10.DecreaseRankOnAnnotation

All Implemented Interfaces:

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

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

Allows you to decrease 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
DecreaseRankOnAnnotation()
DecreaseRankOnAnnotation(DecreaseRankOnAnnotation o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DecreaseRankOnAnnotation.
static DecreaseRankOnAnnotation	fromString(java.lang.String s) String representation of this DecreaseRankOnAnnotation.
java.lang.String	getAnnotationName() Name of the targeted annotation.
java.lang.String	getAnnotationValue() Value of the annotation that will trigger the decrease in ranking.
int	getValue() Number to decrease from the ranking when triggered.
DecreaseRankOnAnnotation	makeCopy() Creates and returns a deep copy of this DecreaseRankOnAnnotation.
static DecreaseRankOnAnnotation	readFrom(java.io.InputStream is) Read this DecreaseRankOnAnnotation 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 decrease in ranking.
void	setValue(int value) Number to decrease from the ranking when triggered.
java.lang.String	toString() String representation of this DecreaseRankOnAnnotation.
DecreaseRankOnAnnotation	withAnnotationName(java.lang.String annotationName)
DecreaseRankOnAnnotation	withAnnotationValue(java.lang.String annotationValue)
DecreaseRankOnAnnotation	withValue(int value)
DecreaseRankOnAnnotation	withValue(java.lang.Integer value)
void	writeTo(java.io.OutputStream os) Write this DecreaseRankOnAnnotation 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

DecreaseRankOnAnnotation

public DecreaseRankOnAnnotation()

DecreaseRankOnAnnotation

public DecreaseRankOnAnnotation(DecreaseRankOnAnnotation 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 DecreaseRankOnAnnotation withAnnotationName(java.lang.String annotationName)

setAnnotationValue

public void setAnnotationValue(java.lang.String annotationValue)

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

getAnnotationValue

public java.lang.String getAnnotationValue()

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

withAnnotationValue

public DecreaseRankOnAnnotation withAnnotationValue(java.lang.String annotationValue)

setValue

public void setValue(int value)

Number to decrease from the ranking when triggered.

getValue

public int getValue()

Number to decrease from the ranking when triggered.

withValue

public DecreaseRankOnAnnotation withValue(int value)

withValue

public DecreaseRankOnAnnotation withValue(java.lang.Integer value)

makeCopy

public DecreaseRankOnAnnotation makeCopy()

Creates and returns a deep copy of this DecreaseRankOnAnnotation.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DecreaseRankOnAnnotation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DecreaseRankOnAnnotation.

Overrides:

toString in class java.lang.Object

check

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

Checks this DecreaseRankOnAnnotation.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException