Package de.unirostock.sems.cbarchive.meta.omex

Class OmexDescription

java.lang.Object

de.unirostock.sems.cbarchive.meta.omex.OmexDescription

public class OmexDescription
extends Object

The Class OmexDescription to parse and create meta data for entries in CombineArchives.

Author:

martin scharm

Field Summary

Fields

Modifier and Type	Field	Description
List<Date>	modified	The dates modified.

Constructor Summary

Constructors

Constructor	Description
OmexDescription()	Instantiates a new omex description.
OmexDescription(VCard creator, Date created)	Instantiates a new omex description.
OmexDescription(VCard creator, Date created, String description)	Instantiates a new omex description.
OmexDescription(String description)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, Date created)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, Date created, String description)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, List<Date> modified)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, List<Date> modified, String description)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, List<Date> modified, Date created)	Instantiates a new omex description.
OmexDescription(List<VCard> creators, List<Date> modified, Date created, String description)	Instantiates a new omex description.
OmexDescription(org.jdom2.Element parent)	Instantiates a new omex description parsed from an XML subtree.

Method Summary

Modifier and Type	Method	Description
OmexDescription	clone()
Date	getCreated()	Gets the date created.
List<VCard>	getCreators()	Gets the creators.
String	getDescription()	Gets the description.
List<Date>	getModified()	Gets the dates modified.
boolean	isEmpty()	Checks if description is empty.
void	setDescription(String description)	Sets the description.
org.json.simple.JSONObject	toJsonDescription()	Export a JSON description of this OMEX description.
void	toXML(org.jdom2.Element parent)	Attach the description to an XML tree.

Methods inherited from class java.lang.Object

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

Field Detail

modified

public List<Date> modified

The dates modified.

Constructor Detail

OmexDescription

public OmexDescription(String description)

Instantiates a new omex description.

Parameters:

description - the textual description

OmexDescription

public OmexDescription(List<VCard> creators,
                       List<Date> modified,
                       String description)

Instantiates a new omex description.

Parameters:

creators - the creators

modified - the date of modifications

description - the textual description

OmexDescription

public OmexDescription(VCard creator,
                       Date created,
                       String description)

Instantiates a new omex description.

Parameters:

creator - the creator

created - the date of creation

description - the textual description

OmexDescription

public OmexDescription(List<VCard> creators,
                       Date created,
                       String description)

Instantiates a new omex description.

Parameters:

creators - the creators

created - the date of creation

description - the textual description

OmexDescription

public OmexDescription(List<VCard> creators,
                       List<Date> modified,
                       Date created,
                       String description)

Instantiates a new omex description.

Parameters:

creators - the creators

modified - the date of modifications

created - the date of creation

description - the textual description

OmexDescription

public OmexDescription()

Instantiates a new omex description.

OmexDescription

public OmexDescription(List<VCard> creators,
                       List<Date> modified)

Instantiates a new omex description.

Parameters:

creators - the creators

modified - the date of modifications

OmexDescription

public OmexDescription(VCard creator,
                       Date created)

Instantiates a new omex description.

Parameters:

creator - the creator

created - the date of creation

OmexDescription

public OmexDescription(List<VCard> creators,
                       Date created)

Instantiates a new omex description.

Parameters:

creators - the creators

created - the date of creation

OmexDescription

public OmexDescription(List<VCard> creators,
                       List<Date> modified,
                       Date created)

Instantiates a new omex description.

Parameters:

creators - the creators

modified - the date of modifications

created - the date of creation

OmexDescription

public OmexDescription(org.jdom2.Element parent)
                throws ParseException

Instantiates a new omex description parsed from an XML subtree.

Parameters:

parent - the parent element

Throws:

ParseException - the parse exception

Method Detail

getDescription

public String getDescription()

Gets the description.

Returns:

the description

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - the description

getCreators

public List<VCard> getCreators()

Gets the creators.

Returns:

the creators

getCreated

public Date getCreated()

Gets the date created.

Returns:

the date created

getModified

public List<Date> getModified()

Gets the dates modified.

Returns:

the dates modified

clone

public OmexDescription clone()

Overrides:

clone in class Object

isEmpty

public boolean isEmpty()

Checks if description is empty.

Returns:

true, if is empty

toXML

public void toXML(org.jdom2.Element parent)

Attach the description to an XML tree.

Parameters:

parent - the parent element

toJsonDescription

public org.json.simple.JSONObject toJsonDescription()

Export a JSON description of this OMEX description.

Returns:

the JSON object