This project has retired. For details please refer to its Attic page.
FileDocumentSource (Apache Any23 :: Core 0.7.0-incubating-SNAPSHOT API)

org.apache.any23.source
Class FileDocumentSource

java.lang.Object
  extended by org.apache.any23.source.FileDocumentSource
All Implemented Interfaces:
DocumentSource

public class FileDocumentSource
extends Object
implements DocumentSource

File implementation of DocumentSource.


Constructor Summary
FileDocumentSource(File file)
           
FileDocumentSource(File file, String baseURI)
           
 
Method Summary
 long getContentLength()
           
 String getContentType()
           
 String getDocumentURI()
           
 boolean isLocal()
          A value of false indicates that the document resides remotely, and that multiple successive accesses to it should be avoided by copying it to local storage.
 InputStream openInputStream()
          Returns the input stream for accessing the content of the document.
 String readStream()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileDocumentSource

public FileDocumentSource(File file)

FileDocumentSource

public FileDocumentSource(File file,
                          String baseURI)
Method Detail

openInputStream

public InputStream openInputStream()
                            throws IOException
Description copied from interface: DocumentSource
Returns the input stream for accessing the content of the document.

Specified by:
openInputStream in interface DocumentSource
Returns:
not null input stream for accessing document data.
Throws:
IOException

getContentLength

public long getContentLength()
Specified by:
getContentLength in interface DocumentSource
Returns:
the size of the content length in bytes.

getDocumentURI

public String getDocumentURI()
Specified by:
getDocumentURI in interface DocumentSource
Returns:
the actual, final, canonical URI if redirects occur.

getContentType

public String getContentType()
Specified by:
getContentType in interface DocumentSource
Returns:
a string describing the content type of the provided document.

isLocal

public boolean isLocal()
Description copied from interface: DocumentSource
A value of false indicates that the document resides remotely, and that multiple successive accesses to it should be avoided by copying it to local storage. This can also be used for sources that do not support multiple calls to DocumentSource.openInputStream().

Specified by:
isLocal in interface DocumentSource

readStream

public String readStream()
                  throws IOException
Throws:
IOException


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.