gov.sandia.cognition.text.document
Interface DocumentReference

All Known Subinterfaces:
FileReference

public interface DocumentReference

Interface for a reference to a document. The references are used to load documents. They must be able to be converted to a URI in order to be loaded.

Since:
3.0
Author:
Justin Basilico

Method Summary
 FileReference getFileReference()
          Gets the reference to the file containing the document.
 URI toURI()
          Converts the document reference to a URI that can be used to locate the document.
 

Method Detail

toURI

URI toURI()
Converts the document reference to a URI that can be used to locate the document.

Returns:
The document reference as a URI.

getFileReference

FileReference getFileReference()
Gets the reference to the file containing the document. If this is already a file, then this reference should be returned. It may be different if, for example, this reference is to a document inside a compressed file like a zip.

Returns:
A reference to the file containing this document.