at.gv.egiz.pdfas.impl.api.commons
Class DataSourceApiAdapter

java.lang.Object
  at.gv.egiz.pdfas.impl.api.commons.DataSourceApiAdapter

All Implemented Interfaces:

DataSource

public class DataSourceApiAdapter

extends Object

implements DataSource

Adapter that converts a framework DataSource to an API PdfDataSource.

Author:

wprinz

Field Summary

protected DataSource

frameworkDataSource The framework DataSource to be adapted to an API DataSource.

Constructor Summary

DataSourceApiAdapter(DataSource frameworkDataSource)
Constructor.

Method Summary

InputStream	createInputStream() Creates a new InputStream that allows to read out the document's binary data from the beginning.
byte[]	getAsByteArray() Returns the data of this DataSource as a byte array for random read only access.
String	getCharacterEncoding() Returns the character encoding of the data.
int	getLength() Returns the length (number of bytes) of the stream.
String	getMimeType() Returns the mime type of the data.

Methods inherited from class java.lang.Object

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

Field Detail

frameworkDataSource

protected DataSource frameworkDataSource

The framework DataSource to be adapted to an API DataSource.

Constructor Detail

DataSourceApiAdapter

public DataSourceApiAdapter(DataSource frameworkDataSource)

Constructor.

Parameters:

frameworkDataSource - The framework DataSource to be adapted to an API DataSource.

Method Detail

createInputStream

public InputStream createInputStream()

Description copied from interface: DataSource

Creates a new InputStream that allows to read out the document's binary data from the beginning.

Specified by:

createInputStream in interface DataSource

Returns:

Returns the InputStream with the binary data.

See Also:

DataSource.createInputStream()

getAsByteArray

public byte[] getAsByteArray()

Description copied from interface: DataSource

Returns the data of this DataSource as a byte array for random read only access.

Calling this method indicates that you need a byte array for random read only access. The DataSource implementation should of course cache this byte array to avoid too much memory usage.

Performance analysis has shown that the libraries internally convert the streams to byte arrays and that file system access is very slow.

Never write to this byte array!

Specified by:

getAsByteArray in interface DataSource

Returns:

Returns the data of this DataSource as a byte array for random read only access.

See Also:

DataSource.getAsByteArray()

getLength

public int getLength()

Description copied from interface: DataSource

Returns the length (number of bytes) of the stream.

Specified by:

getLength in interface DataSource

Returns:

Returns the length (number of bytes) of the stream.

See Also:

DataSource.getLength()

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: DataSource

Returns the character encoding of the data.

This makes only sense for character based mime types.

Specified by:

getCharacterEncoding in interface DataSource

Returns:

Returns the character encoding of the data or null if no encoding is applicable (e.g. if the data is binary).

getMimeType

public String getMimeType()

Description copied from interface: DataSource

Returns the mime type of the data.

Specified by:

getMimeType in interface DataSource

Returns:

Returns the mime type of the data.