org.mycore.datamodel.metadata
Class MCRMetaLangText

java.lang.Object
  org.mycore.datamodel.metadata.MCRMetaDefault
      org.mycore.datamodel.metadata.MCRMetaLangText

All Implemented Interfaces:

Cloneable, MCRMetaInterface

public class MCRMetaLangText
extends MCRMetaDefault

This class implements all method for handling with the MCRMetaLangText part of a metadata object. The MCRMetaLangText class present a single item, which has triples of a text and his corresponding language and optional a type.

Version:

$Revision: 14106 $ $Date: 2008-10-09 11:30:08 +0200 (Do, 09 Okt 2008) $

Author:

Jens Kupferschmidt

Field Summary

protected String	form
protected String	text

Fields inherited from class org.mycore.datamodel.metadata.MCRMetaDefault

datapart, DEFAULT_DATAPART, DEFAULT_INHERITED, DEFAULT_LANG_LENGTH, DEFAULT_LANGUAGE, DEFAULT_STRING_LENGTH, DEFAULT_TYPE_LENGTH, inherited, lang, LOGGER, NL, subtag, type

Constructor Summary

MCRMetaLangText()
This is the constructor.

MCRMetaLangText(String set_datapart, String set_subtag, String default_lang, String set_type, int set_inherted, String set_form, String set_text)
This is the constructor.

Method Summary

Object	clone() This method make a clone of this class.
Element	createXML() This method create a XML stream for all data in this class, defined by the MyCoRe XML MCRMetaLangText definition for the given subtag.
void	debug() This method put debug data to the logger (for the debug mode).
String	getForm() This method get the form attribute.
String	getText() This method get the text element.
boolean	isValid() This method check the validation of the content of this class.
void	set(String set_lang, String set_type, String set_form, String set_text) This method set the languge, type and text.
void	setForm(String set_form) This method set the form attribute.
void	setFromDOM(Element element) This method read the XML input stream part from a DOM part for the metadata of the document.
void	setText(String set_text) This method set the text.

Methods inherited from class org.mycore.datamodel.metadata.MCRMetaDefault

debugDefault, decrementInherited, getDataPart, getInherited, getInheritedToString, getLang, getSubTag, getType, incrementInherited, setDataPart, setInherited, setLang, setSubTag, setType

Methods inherited from class java.lang.Object

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

Field Detail

text

protected String text

form

protected String form

Constructor Detail

MCRMetaLangText

public MCRMetaLangText()

This is the constructor.
The language element was set to en . All other elemnts was set to an empty string. The form Attribute is set to 'plain'.

MCRMetaLangText

public MCRMetaLangText(String set_datapart,
                       String set_subtag,
                       String default_lang,
                       String set_type,
                       int set_inherted,
                       String set_form,
                       String set_text)
                throws MCRException

This is the constructor.
The language element was set. If the value of default_lang is null, empty or false en was set. The subtag element was set to the value of set_subtag. If the value of set_subtag is null or empty an exception was throwed. The type element was set to the value of set_type, if it is null, an empty string was set to the type element. The text element was set to the value of set_text, if it is null, an empty string was set to the text element.

Parameters:

set_datapart - the global part of the elements like 'metadata' or 'service'

set_subtag - the name of the subtag

default_lang - the default language

set_type - the optional type string

set_inherted - a value >= 0

set_form - the format string, if it is empty 'plain' is set.

set_text - the text string

Throws:

MCRException - if the set_subtag value is null or empty

Method Detail

set

public final void set(String set_lang,
                      String set_type,
                      String set_form,
                      String set_text)

This method set the languge, type and text.

Parameters:

set_lang - the new language string, if this is null or empty, nothing is to do

set_type - the optional type syting

set_text - the new text string

setText

public final void setText(String set_text)

This method set the text.

Parameters:

set_text - the new text string

setForm

public final void setForm(String set_form)

This method set the form attribute.

Parameters:

set_form - the new form string

getText

public final String getText()

This method get the text element.

Returns:

the text

getForm

public final String getForm()

This method get the form attribute.

Returns:

the form attribute

setFromDOM

public void setFromDOM(Element element)

This method read the XML input stream part from a DOM part for the metadata of the document.

Specified by:

setFromDOM in interface MCRMetaInterface

Overrides:

setFromDOM in class MCRMetaDefault

Parameters:

element - a relevant JDOM element for the metadata

createXML

public Element createXML()
                  throws MCRException

This method create a XML stream for all data in this class, defined by the MyCoRe XML MCRMetaLangText definition for the given subtag.

Specified by:

createXML in interface MCRMetaInterface

Specified by:

createXML in class MCRMetaDefault

Returns:

a JDOM Element with the XML MCRMetaLangText part

Throws:

MCRException - if the content of this class is not valid

isValid

public boolean isValid()

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

• the subtag is not null or empty
• the text is not null or empty

otherwise the method return false

Specified by:

isValid in interface MCRMetaInterface

Overrides:

isValid in class MCRMetaDefault

Returns:

a boolean value

clone

public Object clone()

This method make a clone of this class.

Specified by:

clone in interface MCRMetaInterface

Specified by:

clone in class MCRMetaDefault

debug

public final void debug()

This method put debug data to the logger (for the debug mode).

Specified by:

debug in interface MCRMetaInterface

Overrides:

debug in class MCRMetaDefault