com.exalead.indexing.analysis.v10

Class RankOnAnnotation

java.lang.Object

com.exalead.indexing.analysis.v10.RankOnAnnotation

All Implemented Interfaces:

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

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

Modifies ranking when some words are flagged by a given annotation.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RankOnAnnotation.
static RankOnAnnotation	fromString(java.lang.String s) String representation of this RankOnAnnotation.
java.lang.String	getAnnotationName() The annotation that triggers the ranking modification.
java.lang.String	getAnnotationValue() The annotation value required to trigger the ranking modification.
int	getForcedRank() The new ranking.
RankOnAnnotation	makeCopy() Creates and returns a deep copy of this RankOnAnnotation.
static RankOnAnnotation	readFrom(java.io.InputStream is) Read this RankOnAnnotation from an XML fragment.
void	setAnnotationName(java.lang.String annotationName) The annotation that triggers the ranking modification.
void	setAnnotationValue(java.lang.String annotationValue) The annotation value required to trigger the ranking modification.
void	setForcedRank(int forcedRank) The new ranking.
java.lang.String	toString() String representation of this RankOnAnnotation.
RankOnAnnotation	withAnnotationName(java.lang.String annotationName)
RankOnAnnotation	withAnnotationValue(java.lang.String annotationValue)
RankOnAnnotation	withForcedRank(int forcedRank)
RankOnAnnotation	withForcedRank(java.lang.Integer forcedRank)
void	writeTo(java.io.OutputStream os) Write this RankOnAnnotation 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

forcedRank

public int forcedRank

Constructor Detail

RankOnAnnotation

public RankOnAnnotation()

RankOnAnnotation

public RankOnAnnotation(RankOnAnnotation o)

Copy constructor

Method Detail

setAnnotationName

public void setAnnotationName(java.lang.String annotationName)

The annotation that triggers the ranking modification.

getAnnotationName

public java.lang.String getAnnotationName()

The annotation that triggers the ranking modification.

withAnnotationName

public RankOnAnnotation withAnnotationName(java.lang.String annotationName)

setAnnotationValue

public void setAnnotationValue(java.lang.String annotationValue)

The annotation value required to trigger the ranking modification.

getAnnotationValue

public java.lang.String getAnnotationValue()

The annotation value required to trigger the ranking modification.

withAnnotationValue

public RankOnAnnotation withAnnotationValue(java.lang.String annotationValue)

setForcedRank

public void setForcedRank(int forcedRank)

The new ranking.

getForcedRank

public int getForcedRank()

The new ranking.

withForcedRank

public RankOnAnnotation withForcedRank(int forcedRank)

withForcedRank

public RankOnAnnotation withForcedRank(java.lang.Integer forcedRank)

makeCopy

public RankOnAnnotation makeCopy()

Creates and returns a deep copy of this RankOnAnnotation.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RankOnAnnotation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RankOnAnnotation.

Overrides:

toString in class java.lang.Object

check

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

Checks this RankOnAnnotation.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException