org.icij.extract.document

Class TikaDocument

java.lang.Object

org.icij.extract.document.TikaDocument

Direct Known Subclasses:

EmbeddedTikaDocument

public class TikaDocument
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TikaDocument.ReaderGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_DISPOSITION
static String	CONTENT_ENCODING
static String	CONTENT_LANGUAGE
static String	CONTENT_LENGTH
static String	CONTENT_LOCATION
static String	CONTENT_MD5
static String	CONTENT_TYPE
static org.apache.tika.metadata.Property	LAST_MODIFIED
static String	LOCATION

Constructor Summary

Constructors

Constructor and Description
TikaDocument(Identifier identifier, Path path)
TikaDocument(Identifier identifier, Path path, org.apache.tika.metadata.Metadata metadata) Instantiate a document when the ID has not yet been generated.
TikaDocument(String id, Identifier identifier, Path path)
TikaDocument(String id, Identifier identifier, Path path, org.apache.tika.metadata.Metadata metadata) Instantiate a document with a pre-generated ID.

Method Summary

Modifier and Type	Method and Description
EmbeddedTikaDocument	addEmbed(org.apache.tika.metadata.Metadata metadata)
EmbeddedTikaDocument	addEmbed(String key, Identifier identifier, Path path, org.apache.tika.metadata.Metadata metadata)
void	clearReader()
boolean	equals(Object other)
EmbeddedTikaDocument	getEmbed(String key)
List<EmbeddedTikaDocument>	getEmbeds()
String	getForeignId()
String	getHash()
String	getId()
org.apache.tika.metadata.Metadata	getMetadata()
String	getMetadata(String fieldName)
Path	getPath()
Reader	getReader()
boolean	hasEmbeds()
int	hashCode()
boolean	removeEmbed(EmbeddedTikaDocument embed)
void	setForeignId(String foreignId)
void	setReader(Reader reader)
void	setReader(TikaDocument.ReaderGenerator readerGenerator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_ENCODING

public static String CONTENT_ENCODING

CONTENT_LANGUAGE

public static String CONTENT_LANGUAGE

CONTENT_LENGTH

public static String CONTENT_LENGTH

CONTENT_LOCATION

public static String CONTENT_LOCATION

CONTENT_DISPOSITION

public static String CONTENT_DISPOSITION

CONTENT_MD5

public static String CONTENT_MD5

CONTENT_TYPE

public static String CONTENT_TYPE

LAST_MODIFIED

public static org.apache.tika.metadata.Property LAST_MODIFIED

LOCATION

public static String LOCATION

Constructor Detail

TikaDocument

public TikaDocument(String id,
                    Identifier identifier,
                    Path path,
                    org.apache.tika.metadata.Metadata metadata)

Instantiate a document with a pre-generated ID. In this case, the ID generator is only used when adding embedded documents to this parent.

Parameters:

id - a pre-generated ID

identifier - an identifier generator

path - the path to the document

metadata - document metadata

TikaDocument

public TikaDocument(String id,
                    Identifier identifier,
                    Path path)

See Also:

(String, Identifier, Path, Metadata)

TikaDocument

public TikaDocument(Identifier identifier,
                    Path path,
                    org.apache.tika.metadata.Metadata metadata)

Instantiate a document when the ID has not yet been generated.

Parameters:

identifier - for generating the ID

path - the path to the document

metadata - document metadata

TikaDocument

public TikaDocument(Identifier identifier,
                    Path path)

See Also:

(Identifier, Path, Metadata)

Method Detail

getId

public String getId()

getHash

public String getHash()

getPath

public Path getPath()

getMetadata

public String getMetadata(String fieldName)

getMetadata

public org.apache.tika.metadata.Metadata getMetadata()

addEmbed

public EmbeddedTikaDocument addEmbed(org.apache.tika.metadata.Metadata metadata)

addEmbed

public EmbeddedTikaDocument addEmbed(String key,
                                     Identifier identifier,
                                     Path path,
                                     org.apache.tika.metadata.Metadata metadata)

removeEmbed

public boolean removeEmbed(EmbeddedTikaDocument embed)

getEmbeds

public List<EmbeddedTikaDocument> getEmbeds()

hasEmbeds

public boolean hasEmbeds()

getEmbed

public EmbeddedTikaDocument getEmbed(String key)

setReader

public void setReader(Reader reader)

setReader

public void setReader(TikaDocument.ReaderGenerator readerGenerator)

clearReader

public void clearReader()

setForeignId

public void setForeignId(String foreignId)

getForeignId

public String getForeignId()

getReader

public Reader getReader()
                 throws IOException

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object