org.icij.extract.document

Class DocumentFactory

java.lang.Object

org.icij.extract.document.DocumentFactory

public class DocumentFactory
extends Object

A factory class for creating TikaDocument objects with default parameters. DocumentQueue implementations should use the create method that instantiates a TikaDocument with all of the information that it is capable of providing. For example, a queue that stores only paths should use the create(Path) method, whereas a queue that stores both a path and ID should use create(String, Path).

Constructor Summary

Constructors

Constructor and Description
DocumentFactory()
DocumentFactory(Options<String> options)

Method Summary

Modifier and Type	Method and Description
DocumentFactory	configure(Options<String> options)
TikaDocument	create(Path path)
TikaDocument	create(Path path, BasicFileAttributes attributes)
TikaDocument	create(Path path, long size)
TikaDocument	create(Path path, org.apache.tika.metadata.Metadata metadata)
TikaDocument	create(String path)
TikaDocument	create(String id, Path path)
TikaDocument	create(String id, Path path, long size)
TikaDocument	create(String id, Path path, org.apache.tika.metadata.Metadata metadata)
TikaDocument	create(String id, String path)
TikaDocument	create(URL url)
DocumentFactory	withIdentifier(Identifier identifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentFactory

public DocumentFactory(Options<String> options)

DocumentFactory

public DocumentFactory()

Method Detail

configure

public DocumentFactory configure(Options<String> options)

withIdentifier

public DocumentFactory withIdentifier(Identifier identifier)

create

public TikaDocument create(String id,
                           Path path)

create

public TikaDocument create(String id,
                           Path path,
                           long size)

create

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

create

public TikaDocument create(Path path)

create

public TikaDocument create(Path path,
                           BasicFileAttributes attributes)

create

public TikaDocument create(Path path,
                           long size)

create

public TikaDocument create(String path)

create

public TikaDocument create(String id,
                           String path)

create

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

create

public TikaDocument create(URL url)
                    throws URISyntaxException

Throws:

URISyntaxException