Package org.mycore.datamodel.metadata
Class MCRMetaAddress
java.lang.Object
org.mycore.datamodel.metadata.MCRMetaDefault
org.mycore.datamodel.metadata.MCRMetaAddress
- All Implemented Interfaces:
Cloneable
,MCRMetaInterface
This class implements all methods for handling with the MCRMetaAddress part
of a metadata object. The MCRMetaAddress class represents a natural address
specified by a list of names.
- Author:
- J. Vogler
-
Field Summary
Fields inherited from class org.mycore.datamodel.metadata.MCRMetaDefault
datapart, DEFAULT_ATTRIBUTE_INHERITED, DEFAULT_ATTRIBUTE_LANG, DEFAULT_ATTRIBUTE_SEQUENCE, DEFAULT_ATTRIBUTE_TYPE, DEFAULT_ELEMENT_DATAPART, DEFAULT_INHERITED, DEFAULT_LANG_LENGTH, DEFAULT_LANGUAGE, DEFAULT_SEQUENCE, DEFAULT_STRING_LENGTH, DEFAULT_TYPE_LENGTH, inherited, lang, NL, sequence, subtag, type
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
clone of this instance you will get a (deep) clone of this elementcom.google.gson.JsonObject
Creates the JSON representation.This method creates a XML stream for all data in this class, defined by the MyCoRe XML MCRMetaAddress definition for the given subtag.void
debug()
This method put debug data to the logger (for the debug mode).boolean
Check the equivalence between this instance and the given object.getCity()
getState()
void
void
setCountry
(String country) void
setFromDOM
(Element element) This method reads the XML input stream part from a DOM part for the metadata of the document.void
void
void
void
setZipCode
(String zipCode) void
validate()
Validates this MCRMetaAddress.Methods inherited from class org.mycore.datamodel.metadata.MCRMetaDefault
debugDefault, decrementInherited, getInherited, getLang, getSequence, getSubTag, getType, hashCode, incrementInherited, isValid, setInherited, setLang, setSequence, setSubTag, setType
-
Constructor Details
-
MCRMetaAddress
public MCRMetaAddress()This is the constructor.
The language element was set to en . All other elemnts are set to an empty string. -
MCRMetaAddress
public MCRMetaAddress(String subtag, String defaultLang, String type, int inherted, String country, String state, String zipcode, String city, String street, String number) throws MCRException This is the constructor.
The language element was set. If the value of defaultLang is null, empty or false en was set. The subtag element was set to the value of subtag. If the value of subtag is null or empty an exception was thrown. The type element was set to the value of type, if it is null, an empty string was set to the type element. The country, state, zipCode, city, street and number element was set to the value of ..., if they are null, an empty string was set to this element.- Parameters:
subtag
- the name of the subtagdefaultLang
- the default languagetype
- the optional type stringinherted
- a value >= 0country
- the country namestate
- the state namezipcode
- the zipCode stringcity
- the city namestreet
- the street namenumber
- the number string- Throws:
MCRException
- if the parameter values are invalid
-
-
Method Details
-
clone
clone of this instance you will get a (deep) clone of this element- Specified by:
clone
in interfaceMCRMetaInterface
- Overrides:
clone
in classMCRMetaDefault
- See Also:
-
createXML
This method creates a XML stream for all data in this class, defined by the MyCoRe XML MCRMetaAddress definition for the given subtag.- Specified by:
createXML
in interfaceMCRMetaInterface
- Overrides:
createXML
in classMCRMetaDefault
- Returns:
- a JDOM Element with the XML MCRMetaAddress part
- Throws:
MCRException
- if the content of this class is not valid
-
createJSON
public com.google.gson.JsonObject createJSON()Creates the JSON representation. Extends theMCRMetaDefault.createJSON()
method with the following data.{ "country": "Deutschland", "state": "Thüringen", "zipcode": "07743", "city": "Jena", "street": "Bibliothekspl.", "number": "2" }
- Specified by:
createJSON
in interfaceMCRMetaInterface
- Overrides:
createJSON
in classMCRMetaDefault
- Returns:
- a GSON object containing the json data of the metadata part
-
debug
public void debug()This method put debug data to the logger (for the debug mode).- Specified by:
debug
in interfaceMCRMetaInterface
- Overrides:
debug
in classMCRMetaDefault
-
equals
Check the equivalence between this instance and the given object.- Overrides:
equals
in classMCRMetaDefault
- Parameters:
obj
- the MCRMetaAddress object- Returns:
- true if its equal
-
getCity
- Returns:
- the city
-
getCountry
- Returns:
- the country
-
getNumber
- Returns:
- the number
-
getState
- Returns:
- the state
-
getStreet
- Returns:
- the street
-
getZipCode
- Returns:
- the zipCode
-
validate
Validates this MCRMetaAddress. This method throws an exception if:- the subtag is not null or empty
- the lang value was supported
- the inherited value is lower than zero
- all of country, state, zip, city, street and number is empty
- Specified by:
validate
in interfaceMCRMetaInterface
- Overrides:
validate
in classMCRMetaDefault
- Throws:
MCRException
- the MCRMetaAddress is invalid
-
setCity
- Parameters:
city
- the city to set
-
setCountry
- Parameters:
country
- the country to set
-
setFromDOM
This method reads the XML input stream part from a DOM part for the metadata of the document.- Specified by:
setFromDOM
in interfaceMCRMetaInterface
- Overrides:
setFromDOM
in classMCRMetaDefault
- Parameters:
element
- a relevant JDOM element for the metadata
-
setNumber
- Parameters:
number
- the number to set
-
setState
- Parameters:
state
- the state to set
-
setStreet
- Parameters:
street
- the street to set
-
setZipCode
- Parameters:
zipCode
- the zipCode to set
-