atg.search.routing.command.search
Class DocumentContextInfo

java.lang.Object
  atg.search.routing.command.search.DocumentContextInfo

All Implemented Interfaces:

java.io.Serializable

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

Document view context information. Created: Dec 8, 2006

See Also:

Serialized Form

Nested Class Summary

class

DocumentContextInfo.Range character offset range in the document

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

DocumentContextInfo(java.lang.String contextInfo)

Method Summary

boolean	equals(java.lang.Object pObject)
int	getHdoc() Returns the document itentifier
java.util.List<DocumentContextInfo.Range>	getRanges() Returns the List of DocumentContextInfo.Range showing highlight regions
void	setHdoc(int hdoc) Sets the document itentifier
void	setRanges(java.util.List<DocumentContextInfo.Range> ranges) Sets the List of DocumentContextInfo.Range showing highlight regions
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

DocumentContextInfo

public DocumentContextInfo(java.lang.String contextInfo)

Parameters:

contextInfo - View context information, in the form: hdoc:[s]start.final,[s]start.final,... where the optional s indicates source, rather than converted text.

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getHdoc

public int getHdoc()

Returns the document itentifier

Returns:

the document itentifier

setHdoc

public void setHdoc(int hdoc)

Sets the document itentifier

Parameters:

hdoc -

getRanges

public java.util.List<DocumentContextInfo.Range> getRanges()

Returns the List of DocumentContextInfo.Range showing highlight regions

Returns:

List of DocumentContextInfo.Range showing highlight regions

setRanges

public void setRanges(java.util.List<DocumentContextInfo.Range> ranges)

Sets the List of DocumentContextInfo.Range showing highlight regions

Parameters:

ranges - List of DocumentContextInfo.Range showing highlight regions

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the original representation of the context info