org.egothor.duplicity.datastructure

Class DocumentUnitID

java.lang.Object

org.egothor.duplicity.datastructure.TextUnitID

org.egothor.duplicity.datastructure.DocumentUnitID

All Implemented Interfaces:

Comparable

public class DocumentUnitID
extends TextUnitID

Class represents a unit of text on document 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 DocumentUnitIDPool so that only one instance of DocumentUnitID 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 DocumentUnitID	getInstance(long documentUID, int documentDBRevision) This is the recommended way to create an instance.
int	hashCode()
static DocumentUnitID	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.TextUnitID

getDocumentDBRevision, getDocumentUID, getInstance, releasePools

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static DocumentUnitID getInstance(long documentUID,
                                         int documentDBRevision)

This is the recommended way to create an instance.

Parameters:

documentUID -

documentDBRevision -

toString

public String toString()

Overrides:

toString in class Object

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.

Specified by:

toNiceMeString in class TextUnitID

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.

Specified by:

toNiceOtherString in class TextUnitID

Returns:

string representation of the object

compareTo

public int compareTo(Object obj)

Parameters:

obj -

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

store

public void store(DataOutputStream dos)
           throws IOException

Specified by:

store in class TextUnitID

Parameters:

dos -

Throws:

IOException

load

public static DocumentUnitID load(DataInputStream dis)
                           throws IOException

Parameters:

dis -

Returns:

Throws:

IOException