org.cishell.framework.data
Interface Data

All Known Implementing Classes:

BasicData

public interface Data

A class that contains data, its format, and its metadata. This class is used to pass data between algorithms and is what algorithms optionally create when executed.

Author:

Bruce Herr (bh2@bh2.net)

Method Summary

Object	getData() Returns the data stored in this Data object
String	getFormat() Returns the format of the encapsulated data.
Dictionary	getMetadata() Returns the metadata associated with the data stored in this Data object.

Method Detail

getMetadata

Dictionary getMetadata()

Returns the metadata associated with the data stored in this Data object. Standard keys and values are in the DataProperty interface.

Returns:

The data's metadata

getData

Object getData()

Returns the data stored in this Data object

Returns:

The data (a Java object)

getFormat

String getFormat()

Returns the format of the encapsulated data. If the data is a File, then this method returns what MIME type it is with "file:" prepended (eg. file:text/plain). Otherwise, the string returned should be the Java class it represents. For algorithms this format should be the same as their OUT_DATA property.

Returns:

The main format of the data