com.sovren.models

Class Document

java.lang.Object

com.sovren.models.Document

public class Document
extends Object

Represents an unparsed document (a file on the filesystem, byte[] from a database, etc)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_asBase64
java.time.LocalDate	LastModified The last revised/modified date for this file.

Constructor Summary

Constructors

Constructor and Description
Document(byte[] fileBytes, java.time.LocalDate lastModified) Create a Document from a file byte[]
Document(String path) Create a Document from a file on the filesystem.

Method Summary

Modifier and Type	Method and Description
String	getAsBase64()

Methods inherited from class java.lang.Object

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

Field Detail

_asBase64

protected String _asBase64

LastModified

public java.time.LocalDate LastModified

The last revised/modified date for this file.

Constructor Detail

Document

public Document(byte[] fileBytes,
                java.time.LocalDate lastModified)

Create a Document from a file byte[]

Parameters:

fileBytes - - The file byte array

lastModified - - The last-revised date for this file.

Per our AUP (https://sovren.com/policies-and-agreements/acceptable-use-policy/), you MUST pass a good-faith last-revised date for every parse transaction.

This is extremely important so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" (or similar) to correctly calculate date spans

Throws:

IllegalArgumentException - If the fileBytes is null or empty

Document

public Document(String path)
         throws IOException

Create a Document from a file on the filesystem.

NOTE: this will automatically set the LastModified using Files.getLastModifiedTime(Path, LinkOption...)

If your files do not have an accurate 'LastWrite' or 'LastModified' time, you must use a different constructor

Parameters:

path - - The path to the file

Throws:

IllegalArgumentException - If the file is empty

IOException - If an error occurs reading the file contents

Method Detail

getAsBase64

public String getAsBase64()

Returns:

The base-64 encoded byte[] for this file. This is what is sent over HTTPS to Sovren's API