Package org.pentaho.reporting.libraries.docbundle

Class MemoryDocumentMetaData

java.lang.Object

org.pentaho.reporting.libraries.docbundle.MemoryDocumentMetaData

All Implemented Interfaces:

Serializable, Cloneable, DocumentMetaData, WriteableDocumentMetaData

public class MemoryDocumentMetaData
extends Object
implements WriteableDocumentMetaData

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MemoryDocumentMetaData()

Method Summary

Modifier and Type	Method	Description
Object	clone()
Object	getBundleAttribute(String namespace, String attributeName)	Returns a single document-meta-data attribute.
String	getBundleType()	Returns the bundle's defined mime-type.
String	getEntryAttribute(String entryName, String attributeName)
String[]	getEntryAttributeNames(String entryName)
String	getEntryMimeType(String entry)	Returns the declared mime-type for the given entry.
String[]	getManifestEntryNames()
String[]	getMetaDataNames(String namespace)
String[]	getMetaDataNamespaces()
boolean	removeEntry(String entry)
void	setBundleAttribute(String namespace, String name, Object value)
void	setBundleType(String type)
void	setEntryAttribute(String entryName, String attributeName, String value)
void	setEntryMimeType(String entry, String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryDocumentMetaData

public MemoryDocumentMetaData()

Method Detail

setBundleType

public void setBundleType(String type)

Specified by:

setBundleType in interface WriteableDocumentMetaData

setBundleAttribute

public void setBundleAttribute(String namespace,
                               String name,
                               Object value)

Specified by:

setBundleAttribute in interface WriteableDocumentMetaData

getBundleType

public String getBundleType()

Returns the bundle's defined mime-type. This value is read from the "/mimetype" entry (if existent) else from the manifest's "/" entry. The bundle type acts as a hint for the content processor on what content the main document contains. This entry is declarative - if the actual main document does not match the declared bundle type, parsing is allowed to fail.

Specified by:

getBundleType in interface DocumentMetaData

Returns:

the bundle type.

getEntryMimeType

public String getEntryMimeType(String entry)

Returns the declared mime-type for the given entry. The mime-type is declarative - if it does not match the actual content of the entry, the content processor may raise an error.

Specified by:

getEntryMimeType in interface DocumentMetaData

Parameters:

entry - the entry path.

Returns:

the mime-type.

getBundleAttribute

public Object getBundleAttribute(String namespace,
                                 String attributeName)

Returns a single document-meta-data attribute. Each attribute is specified by a namespace and attribute name and contains a single string value.

Specified by:

getBundleAttribute in interface DocumentMetaData

Parameters:

namespace - the namespace uri

attributeName - the attribute name

Returns:

the attribute value.

getManifestEntryNames

public String[] getManifestEntryNames()

Specified by:

getManifestEntryNames in interface DocumentMetaData

setEntryMimeType

public void setEntryMimeType(String entry,
                             String type)

Specified by:

setEntryMimeType in interface WriteableDocumentMetaData

setEntryAttribute

public void setEntryAttribute(String entryName,
                              String attributeName,
                              String value)

Specified by:

setEntryAttribute in interface WriteableDocumentMetaData

removeEntry

public boolean removeEntry(String entry)

Specified by:

removeEntry in interface WriteableDocumentMetaData

getMetaDataNamespaces

public String[] getMetaDataNamespaces()

Specified by:

getMetaDataNamespaces in interface DocumentMetaData

getMetaDataNames

public String[] getMetaDataNames(String namespace)

Specified by:

getMetaDataNames in interface DocumentMetaData

getEntryAttribute

public String getEntryAttribute(String entryName,
                                String attributeName)

Specified by:

getEntryAttribute in interface DocumentMetaData

getEntryAttributeNames

public String[] getEntryAttributeNames(String entryName)

Specified by:

getEntryAttributeNames in interface DocumentMetaData

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface DocumentMetaData

Overrides:

clone in class Object

Throws:

CloneNotSupportedException