Package de.unirostock.sems.cbarchive.meta

Class OmexMetaDataObject

java.lang.Object

de.unirostock.sems.cbarchive.meta.MetaDataObject

de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

public class OmexMetaDataObject
extends MetaDataObject

The Class OmexMetaDataObject representing meta data in OMEX format.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field	Description
protected OmexDescription	description	The description.

Fields inherited from class de.unirostock.sems.cbarchive.meta.MetaDataObject

about, fragmentIdentifier

Constructor Summary

Constructors

Constructor	Description
OmexMetaDataObject(OmexDescription description)	Instantiates a new OMEX meta data object.
OmexMetaDataObject(OmexDescription description, org.jdom2.Element describingElement)	Instantiates a new OMEX meta data object.

Method Summary

Modifier and Type	Method	Description
MetaDataObject	clone()
OmexDescription	getOmexDescription()	Gets the omex description.
void	injectDescription(org.jdom2.Element parent)	Inject the description into parent.
static OmexMetaDataObject	tryToRead(org.jdom2.Element element)	Try to read a meta data object.

Methods inherited from class de.unirostock.sems.cbarchive.meta.MetaDataObject

equals, equalsPathNoMatter, getAbout, getXmlDescription, setAbout, setAbout

Methods inherited from class java.lang.Object

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

Field Detail

description

protected OmexDescription description

The description.

Constructor Detail

OmexMetaDataObject

public OmexMetaDataObject(OmexDescription description)

Instantiates a new OMEX meta data object.

Parameters:

description - the description

OmexMetaDataObject

public OmexMetaDataObject(OmexDescription description,
                          org.jdom2.Element describingElement)

Instantiates a new OMEX meta data object.

Parameters:

description - the description

describingElement - the element rooting the subtree that describes about

Method Detail

injectDescription

public void injectDescription(org.jdom2.Element parent)

Description copied from class: MetaDataObject

Inject the description into parent.

Specified by:

injectDescription in class MetaDataObject

Parameters:

parent - the parent element that will host the description

getOmexDescription

public OmexDescription getOmexDescription()

Gets the omex description.

Returns:

the omex description

tryToRead

public static OmexMetaDataObject tryToRead(org.jdom2.Element element)

Try to read a meta data object. Might return null if element cannot be understood as an OMEX description.

Parameters:

element - the element rooting the meta data subtree

Returns:

the OMEX meta data object if in proper format, or null if we cannot parse the element

clone

public MetaDataObject clone()

Specified by:

clone in class MetaDataObject