org.conqat.engine.index.shared

Class BasicTokenElementInfo

java.lang.Object

org.conqat.engine.index.shared.BasicTokenElementInfo

All Implemented Interfaces:

java.io.Serializable

public class BasicTokenElementInfo
extends java.lang.Object
implements java.io.Serializable

Transport object with the information needed for a token element. This class is immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<TokenElementDetailBase>	details Additional details of this info object.
protected java.util.ArrayList<Deletion>	filterDeletions The list of filtered regions
protected ELanguage	language The language.
protected java.lang.String	text The text content.
protected java.lang.String	uniformPath The uniform path.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicTokenElementInfo(BasicTokenElementInfo other) Copy constructor.
	BasicTokenElementInfo(java.lang.String uniformPath, ELanguage language, java.lang.String text, java.util.Collection<Deletion> filterDeletions, java.util.Collection<TokenElementDetailBase> details) Constructor.

Method Summary

Modifier and Type	Method and Description
UnmodifiableList<TokenElementDetailBase>	getDetails()
UnmodifiableList<Deletion>	getFilterDeletions() Returns the filter deletions.
java.lang.String	getFilteredText() Returns the filtered text of this token element.
<T extends TokenElementDetailBase> T	getFirstDetailOfType(java.lang.Class<T> type) Returns the first detail of given type (or null).
static <T extends TokenElementDetailBase> T	getFirstDetailOfType(java.lang.Class<T> type, java.util.List<TokenElementDetailBase> details) Returns the first detail of given type (or null) in the given list.
ELanguage	getLanguage() Returns the language.
java.lang.String	getText() Returns the text content.
java.lang.String	getUniformPath() Returns the uniform path.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uniformPath

protected final java.lang.String uniformPath

The uniform path.

language

protected final ELanguage language

The language.

text

protected final java.lang.String text

The text content.

filterDeletions

protected final java.util.ArrayList<Deletion> filterDeletions

The list of filtered regions

details

protected final java.util.ArrayList<TokenElementDetailBase> details

Additional details of this info object.

Constructor Detail

BasicTokenElementInfo

public BasicTokenElementInfo(java.lang.String uniformPath,
                             ELanguage language,
                             java.lang.String text,
                             java.util.Collection<Deletion> filterDeletions,
                             java.util.Collection<TokenElementDetailBase> details)

Constructor.

BasicTokenElementInfo

protected BasicTokenElementInfo(BasicTokenElementInfo other)

Copy constructor.

Method Detail

getUniformPath

public java.lang.String getUniformPath()

Returns the uniform path.

getLanguage

public ELanguage getLanguage()

Returns the language.

getText

public java.lang.String getText()

Returns the text content. Note that this is the raw content, not taking into account content filters stored in filterDeletions. To obtain the filtered content, transform this into an ITokenElement.

getFilteredText

public java.lang.String getFilteredText()

Returns the filtered text of this token element. Please note that the filtered content is computed on the fly.

getFilterDeletions

public UnmodifiableList<Deletion> getFilterDeletions()

Returns the filter deletions.

getDetails

public UnmodifiableList<TokenElementDetailBase> getDetails()

See Also:

details

getFirstDetailOfType

public <T extends TokenElementDetailBase> T getFirstDetailOfType(java.lang.Class<T> type)

Returns the first detail of given type (or null).

getFirstDetailOfType

public static <T extends TokenElementDetailBase> T getFirstDetailOfType(java.lang.Class<T> type,
                                                                        java.util.List<TokenElementDetailBase> details)

Returns the first detail of given type (or null) in the given list.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object