org.mycore.datamodel.metadata
Class MCRObjectDerivate

java.lang.Object
  org.mycore.datamodel.metadata.MCRObjectDerivate

public class MCRObjectDerivate
extends Object

This class implements all methode for handling one derivate data.

Version:

$Revision: 14863 $ $Date: 2008-02-06 18:27:24 +0100 (Mi, 06. Feb 2008) $

Author:

Jens Kupferschmidt

Constructor Summary

MCRObjectDerivate()
This is the constructor of the MCRObjectDerivate class.

Method Summary

Element	createXML() This methode create a XML stream for all derivate data.
MCRMetaLink	getExternal(int index) This method get a single link from the external list as a MCRMetaLink.
int	getExternalSize() This method return the size of the external array.
MCRMetaIFS	getInternals() This method get a single data from the internal list as a MCRMetaIFS.
MCRMetaLinkID	getMetaLink() returns link to the MCRObject.
MCRMetaLangText	getTitle(int index) This method get a single text from the titles list as a MCRMetaLangText.
int	getTitleSize() This method return the size of the title array.
boolean	isValid() This method check the validation of the content of this class.
void	setFromDOM(Element derivate_element) This methode read the XML input stream part from a DOM part for the structure data of the document.
void	setInternals(MCRMetaIFS in_ifs) This method set the metadata internals (the IFS data)
void	setLinkMeta(MCRMetaLinkID in_link) This method set the metadata link

Methods inherited from class java.lang.Object

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

Constructor Detail

MCRObjectDerivate

public MCRObjectDerivate()

This is the constructor of the MCRObjectDerivate class. All data are set to null.

Method Detail

setFromDOM

public final void setFromDOM(Element derivate_element)

This methode read the XML input stream part from a DOM part for the structure data of the document.

Parameters:

derivate_element - a list of relevant DOM elements for the derivate

getMetaLink

public MCRMetaLinkID getMetaLink()

returns link to the MCRObject.

Returns:

a metadata link as MCRMetaLinkID

setLinkMeta

public final void setLinkMeta(MCRMetaLinkID in_link)

This method set the metadata link

Parameters:

in_link - the MCRMetaLinkID object

getExternalSize

public final int getExternalSize()

This method return the size of the external array.

getExternal

public final MCRMetaLink getExternal(int index)
                              throws IndexOutOfBoundsException

This method get a single link from the external list as a MCRMetaLink.

Returns:

a external link as MCRMetaLink

Throws:

IndexOutOfBoundsException - throw this exception, if the index is false

getTitleSize

public final int getTitleSize()

This method return the size of the title array.

getTitle

public final MCRMetaLangText getTitle(int index)
                               throws IndexOutOfBoundsException

This method get a single text from the titles list as a MCRMetaLangText.

Returns:

a title text as MCRMetaLangText

Throws:

IndexOutOfBoundsException - throw this exception, if the index is false

getInternals

public final MCRMetaIFS getInternals()

This method get a single data from the internal list as a MCRMetaIFS.

Returns:

a internal data as MCRMetaIFS

setInternals

public final void setInternals(MCRMetaIFS in_ifs)

This method set the metadata internals (the IFS data)

Parameters:

in_ifs - the MCRMetaIFS object

createXML

public final Element createXML()
                        throws MCRException

This methode create a XML stream for all derivate data.

Returns:

a JDOM Element with the XML data of the structure data part

Throws:

MCRException - if the content of this class is not valid

isValid

public final boolean isValid()

This method check the validation of the content of this class. The method returns true if

• the linkmeta exist and the XLink type of linkmeta is not "arc"
• no information in the external AND internal tags

Returns:

a boolean value