org.egothor.duplicity.datastructure

Class SentenceUnitID

java.lang.Object

org.egothor.duplicity.datastructure.TextUnitID

org.egothor.duplicity.datastructure.ParagraphUnitID

org.egothor.duplicity.datastructure.SentenceUnitID

All Implemented Interfaces:

Comparable

public class SentenceUnitID
extends ParagraphUnitID

Class represents a unit of text on sentence duplicity checking level (see Constants.CHECK_DUPLICITY_LEVEL). This class is *IMMUTABLE*, which means that each time a method that is supposed to change something is called, another instance is returned. The objects of this type are pooled using SentenceUnitIDPool so that only one instance of SentenceUnitID exists for each document.

Author:

Kateřina Dufková

Field Summary

Fields inherited from class org.egothor.duplicity.datastructure.TextUnitID

GENERAL_SEP, REVISION_SEP

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object obj)
boolean	equals(Object obj)
static SentenceUnitID	getInstance(long documentUID, int documentDBRevision, short paragraph, short sentenceInParagraph) This is the recommended way to create an instance.
short	getSentenceInParagraph()
int	hashCode()
static SentenceUnitID	load(DataInputStream dis)
void	store(DataOutputStream dos)
String	toNiceMeString() Returns textual representation of the unit to be printed in duplicity checking reports.
String	toNiceOtherString() Returns textual representation of the unit to be printed in duplicity checking reports.
String	toString()

Methods inherited from class org.egothor.duplicity.datastructure.ParagraphUnitID

getInstance, getParagraph

Methods inherited from class org.egothor.duplicity.datastructure.TextUnitID

getDocumentDBRevision, getDocumentUID, getInstance, releasePools

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static SentenceUnitID getInstance(long documentUID,
                                         int documentDBRevision,
                                         short paragraph,
                                         short sentenceInParagraph)

This is the recommended way to create an instance.

Parameters:

documentUID -

documentDBRevision -

paragraph -

sentenceInParagraph -

getSentenceInParagraph

public short getSentenceInParagraph()

Returns:

toString

public String toString()

Overrides:

toString in class ParagraphUnitID

Returns:

toNiceMeString

public String toNiceMeString()

Returns textual representation of the unit to be printed in duplicity checking reports. This is used for identifying units in the examined document and should not contain document id.

Overrides:

toNiceMeString in class ParagraphUnitID

Returns:

string representation of the object

toNiceOtherString

public String toNiceOtherString()

Returns textual representation of the unit to be printed in duplicity checking reports. This is used for identifying units in the already indexed documents and should contain document id.

Overrides:

toNiceOtherString in class ParagraphUnitID

Returns:

string representation of the object

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class ParagraphUnitID

Parameters:

obj -

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class ParagraphUnitID

Parameters:

obj -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class ParagraphUnitID

Returns:

store

public void store(DataOutputStream dos)
           throws IOException

Overrides:

store in class ParagraphUnitID

Parameters:

dos -

Throws:

IOException

load

public static SentenceUnitID load(DataInputStream dis)
                           throws IOException

Parameters:

dis -

Returns:

Throws:

IOException