org.egothor.core

Class DocumentData

java.lang.Object

org.egothor.core.DocumentData

All Implemented Interfaces:

Cloneable

public final class DocumentData
extends Object
implements Cloneable

The DocumentData object is the root of all document metadata objects. This class is not synchronized.

Author:

Leo Galambos

Constructor Summary

Constructors

Constructor and Description
DocumentData(DocumentData old) Construct a new DocumentData object using the Hashtable of the given DocumentData object.
DocumentData(long uid) Constructor for the DocumentData object.
DocumentData(long uid, int docDBRevision)
DocumentData(long uid, long revision)

Method Summary

Modifier and Type	Method and Description
Object	clone()
void	computeMins(PermutatedMinsFiller permutatedMinsFiller)
String	convertData2String()
String	convertData2String(String encoding)
String	getContentType()
byte[]	getData()
int	getDataLen()
long	getDateTime()
int	getDocDBRevision()
DocumentPermutatedMins	getDocumentMins()
DocumentUnitID	getDocumentUnitID() Get DocumentUnitID object representing this DocumentData.
String	getLocation()
String	getOriginalContentType()
int	getRevision()
String	getTitle()
long	getUID()
boolean	isResolved()
void	load(DataInput dis) Read this object into the given input stream.
void	printCached(Writer out, String cached_msg, String sorry_msg)
void	releaseDocumentMins()
void	setCheckDuplicity(boolean checkDuplicity)
void	setContentType(String contentType)
void	setData(String contentType, byte[] data)
void	setData(String contentType, byte[] data, int data_len)
void	setData(String contentType, String data, String encoding)
void	setDateTime(long dateTime)
void	setDocDBRevision(int docDBRevision)
void	setDocumentMins(DocumentPermutatedMins documentMins)
void	setFakeData(String contentType, String data, String encoding) Sets a new content, but does not change the length of the original data block.
void	setLocation(String location)
void	setOriginalContentType(String originalContentType)
void	setRevision(int revision)
void	setTitle(String title)
void	setUID(long uid)
void	store(DataOutput dos) Write this object to the given output stream.
String	toString() Construct a String representation of this HTMLMetadata object.
Sequence<Token>	words(boolean readlinx, boolean readilinx, boolean lowercase, boolean phonetics, HTMLField.Diacritics diacritics, boolean paragraphs, boolean paragraphsKeepPunctuation, String encoding)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentData

public DocumentData(long uid)

Constructor for the DocumentData object.

DocumentData

public DocumentData(long uid,
                    int docDBRevision)

DocumentData

public DocumentData(long uid,
                    long revision)

DocumentData

public DocumentData(DocumentData old)

Construct a new DocumentData object using the Hashtable of the given DocumentData object.

Parameters:

old - the DocumentData object containing the metadata for the new object

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

printCached

public void printCached(Writer out,
                        String cached_msg,
                        String sorry_msg)
                 throws IOException,
                        URISyntaxException

Throws:

IOException

URISyntaxException

toString

public String toString()

Construct a String representation of this HTMLMetadata object.

Overrides:

toString in class Object

Returns:

This implementation returns a string that looks like this: Title [Location] :Summary

convertData2String

public String convertData2String(String encoding)
                          throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

convertData2String

public final String convertData2String()

store

public void store(DataOutput dos)
           throws IOException

Write this object to the given output stream.

Parameters:

dos - the output stream

Throws:

IOException - Description of the Exception

load

public void load(DataInput dis)
          throws IOException

Read this object into the given input stream.

Parameters:

dis - the input stream

Throws:

IOException - Description of the Exception

isResolved

public boolean isResolved()

getUID

public long getUID()

setUID

public void setUID(long uid)

getData

public byte[] getData()

getDataLen

public int getDataLen()

setData

public void setData(String contentType,
                    byte[] data,
                    int data_len)

setData

public final void setData(String contentType,
                          byte[] data)

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

setContentType

public void setContentType(String contentType)

setData

public void setData(String contentType,
                    String data,
                    String encoding)
             throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

setFakeData

public void setFakeData(String contentType,
                        String data,
                        String encoding)
                 throws UnsupportedEncodingException

Sets a new content, but does not change the length of the original data block. This method is used when the content of this document should be replaced with some snippet replacing the full text.

Throws:

UnsupportedEncodingException

getContentType

public String getContentType()

getDateTime

public long getDateTime()

setDateTime

public void setDateTime(long dateTime)

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

getOriginalContentType

public String getOriginalContentType()

setOriginalContentType

public void setOriginalContentType(String originalContentType)

getRevision

public int getRevision()

setRevision

public void setRevision(int revision)

getDocDBRevision

public int getDocDBRevision()

setDocDBRevision

public void setDocDBRevision(int docDBRevision)

getDocumentMins

public DocumentPermutatedMins getDocumentMins()

setDocumentMins

public void setDocumentMins(DocumentPermutatedMins documentMins)

releaseDocumentMins

public void releaseDocumentMins()

setCheckDuplicity

public void setCheckDuplicity(boolean checkDuplicity)

words

public Sequence<Token> words(boolean readlinx,
                             boolean readilinx,
                             boolean lowercase,
                             boolean phonetics,
                             HTMLField.Diacritics diacritics,
                             boolean paragraphs,
                             boolean paragraphsKeepPunctuation,
                             String encoding)
                      throws DuplicityCheckingException

Throws:

DuplicityCheckingException

computeMins

public void computeMins(PermutatedMinsFiller permutatedMinsFiller)
                 throws DuplicityCheckingException

Throws:

DuplicityCheckingException

getDocumentUnitID

public DocumentUnitID getDocumentUnitID()

Get DocumentUnitID object representing this DocumentData.

Returns:

DocumentUnitID