de.dth.mdr.validator

Class MdrKey

java.lang.Object

de.dth.mdr.validator.MdrKey

All Implemented Interfaces:

Serializable, Comparable<MdrKey>

public class MdrKey
extends Object
implements Serializable, Comparable<MdrKey>

MDR Key model.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MdrKey() Instantiates a new mdr key.
MdrKey(String mdrKey, MdrConnection mdrConnection) Instantiates a new mdr key.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MdrKey o)
boolean	equals(Object obj)
String	forXml() Returns the MDR key as we need it for the import/export XMLs.
de.samply.common.mdrclient.domain.Catalogue	getCatalogue() Todo.
de.samply.common.mdrclient.domain.Definition	getDefinition() Gets the definition.
String	getId() Gets the id.
String	getKeyWithoutVersion()
List<de.samply.common.mdrclient.domain.Label>	getLabel() Gets a list of mdr key labels.
String	getMdrDefinition() Gets this mdrkey's first definition as string.
String	getMdrDesignation() gets this mdrkey's first designation as string.
String	getMdrLabel() gets this mdrkey's first designation as string.
List<de.samply.common.mdrclient.domain.Result>	getMembers() Gets a list of record or group members.
Set<MdrKey>	getMembersSet() Gets the members of a mdr record or a mdr group.
Set<MdrKey>	getMembersSet(de.samply.common.mdrclient.domain.EnumElementType type) Gets the members of specific type from a mdr record or a mdr group.
String	getNamespace() Gets the namespace.
String	getSingleSlotValue(String slotKey) Gets the only slot value of a key.
List<de.samply.common.mdrclient.domain.Slot>	getSlots() Retuns the slots of this dataelement.
String	getSlotValue(String slotKey) Deprecated.
String	getSlotValueLazyLoading(String slotKey) Deprecated.
List<String>	getSlotValues(String slotKey) Gets the slot values of a key.
de.samply.common.mdrclient.domain.EnumElementType	getType() Gets the type.
de.samply.common.mdrclient.domain.Validations	getValidations() Returns the Validations of this dataelement.
String	getVersion() Gets the version.
int	hashCode()
boolean	isGroup() Checks if the mdrKey represents a dataelementgroup.
Boolean	isRecord() checks if a mdrkey represents a record.
void	loadDataElement() Load the whole Dataelement in order to reduce (costly) calls to the mdr.
String	namespaceForXml() gets the namespace part of this mdrkey.
Boolean	parseString(String mdrKey) Parses a string representation of a mdr key.
String	purify() Returns a version of the MDRkey in which dots are replaced with one underscore and colons are replaced with double underscores colons and dots are illegal characters in maps and JSF params so we need to replace them in a way that our backend saver can recognize and re-replace with the original character.
void	setId(String id) Sets the id.
void	setNamespace(String namespace) Sets the namespace.
void	setType(de.samply.common.mdrclient.domain.EnumElementType type) Sets the type.
void	setVersion(String version) Sets the version.
String	toString() Returns a string representation of this mdr key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MdrKey

public MdrKey()

Instantiates a new mdr key.

MdrKey

public MdrKey(String mdrKey,
              MdrConnection mdrConnection)

Instantiates a new mdr key.

Parameters:

mdrKey - the mdr key

mdrConnection - the mdr connection

Method Detail

getMembersSet

public Set<MdrKey> getMembersSet()
                          throws de.samply.common.mdrclient.MdrConnectionException,
                                 ExecutionException,
                                 MdrException

Gets the members of a mdr record or a mdr group.

Returns:

set of MdrKey

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the MDR exception

getMembersSet

public Set<MdrKey> getMembersSet(de.samply.common.mdrclient.domain.EnumElementType type)
                          throws de.samply.common.mdrclient.MdrConnectionException,
                                 ExecutionException,
                                 MdrException

Gets the members of specific type from a mdr record or a mdr group.

Parameters:

type - the type of the members

Returns:

set of MdrKeys with a specific type

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the MDR exception

getMembers

public List<de.samply.common.mdrclient.domain.Result> getMembers()
                                                          throws de.samply.common.mdrclient.MdrConnectionException,
                                                                 ExecutionException,
                                                                 MdrException

Gets a list of record or group members.

Returns:

list of mdrclient.domain.Result

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the MDR exception

getLabel

public List<de.samply.common.mdrclient.domain.Label> getLabel()
                                                       throws de.samply.common.mdrclient.MdrConnectionException,
                                                              ExecutionException,
                                                              MdrException

Gets a list of mdr key labels.

Returns:

the label

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the MDR exception

getDefinition

public de.samply.common.mdrclient.domain.Definition getDefinition()
                                                           throws de.samply.common.mdrclient.MdrConnectionException,
                                                                  de.samply.common.mdrclient.MdrInvalidResponseException,
                                                                  ExecutionException

Gets the definition.

Returns:

the definition

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

de.samply.common.mdrclient.MdrInvalidResponseException - the mdr invalid response exception

ExecutionException - the execution exception

getMdrDefinition

public String getMdrDefinition()
                        throws de.samply.common.mdrclient.MdrConnectionException,
                               ExecutionException,
                               MdrException,
                               de.samply.common.mdrclient.MdrInvalidResponseException

Gets this mdrkey's first definition as string.

Returns:

the mdr definition

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the OSSE exception

de.samply.common.mdrclient.MdrInvalidResponseException - the mdr invalid response exception

getMdrDesignation

public String getMdrDesignation()
                         throws de.samply.common.mdrclient.MdrConnectionException,
                                ExecutionException,
                                MdrException,
                                de.samply.common.mdrclient.MdrInvalidResponseException

gets this mdrkey's first designation as string.

Returns:

the mdr designation

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the OSSE exception

de.samply.common.mdrclient.MdrInvalidResponseException - the mdr invalid response exception

getMdrLabel

public String getMdrLabel()
                   throws de.samply.common.mdrclient.MdrConnectionException,
                          ExecutionException,
                          MdrException,
                          de.samply.common.mdrclient.MdrInvalidResponseException

gets this mdrkey's first designation as string.

Returns:

the mdr label

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

ExecutionException - the execution exception

MdrException - the OSSE exception

de.samply.common.mdrclient.MdrInvalidResponseException - the mdr invalid response exception

parseString

public Boolean parseString(String mdrKey)

Parses a string representation of a mdr key.

Parameters:

mdrKey - the mdr key

Returns:

boolean if this is a real mdr key

toString

public String toString()

Returns a string representation of this mdr key.

Overrides:

toString in class Object

Returns:

the string

purify

public String purify()

Returns a version of the MDRkey in which dots are replaced with one underscore and colons are replaced with double underscores colons and dots are illegal characters in maps and JSF params so we need to replace them in a way that our backend saver can recognize and re-replace with the original character.

Returns:

the purified mdrkey as string

forXml

public String forXml()

Returns the MDR key as we need it for the import/export XMLs.

Returns:

the string

namespaceForXml

public String namespaceForXml()

gets the namespace part of this mdrkey.

Returns:

the string

isRecord

public Boolean isRecord()

checks if a mdrkey represents a record.

Returns:

the boolean

loadDataElement

public void loadDataElement()
                     throws ExecutionException,
                            de.samply.common.mdrclient.MdrConnectionException,
                            de.samply.common.mdrclient.MdrInvalidResponseException

Load the whole Dataelement in order to reduce (costly) calls to the mdr.

Throws:

ExecutionException

de.samply.common.mdrclient.MdrConnectionException

de.samply.common.mdrclient.MdrInvalidResponseException

getValidations

public de.samply.common.mdrclient.domain.Validations getValidations()
                                                             throws de.samply.common.mdrclient.MdrConnectionException,
                                                                    de.samply.common.mdrclient.MdrInvalidResponseException,
                                                                    ExecutionException,
                                                                    MdrException

Returns the Validations of this dataelement.

Returns:

the Validations

Throws:

de.samply.common.mdrclient.MdrConnectionException - the mdr connection exception

de.samply.common.mdrclient.MdrInvalidResponseException - the mdr invalid response exception

ExecutionException - the execution exception

MdrException - the OSSE exception

getCatalogue

public de.samply.common.mdrclient.domain.Catalogue getCatalogue()
                                                         throws ExecutionException,
                                                                de.samply.common.mdrclient.MdrConnectionException,
                                                                de.samply.common.mdrclient.MdrInvalidResponseException

Todo.

Returns:

Todo.

Throws:

ExecutionException - Todo.

de.samply.common.mdrclient.MdrConnectionException - Todo.

de.samply.common.mdrclient.MdrInvalidResponseException - Todo.

getSlots

public List<de.samply.common.mdrclient.domain.Slot> getSlots()
                                                      throws de.samply.common.mdrclient.MdrConnectionException,
                                                             de.samply.common.mdrclient.MdrInvalidResponseException,
                                                             ExecutionException

Retuns the slots of this dataelement.

Returns:

the slots

Throws:

de.samply.common.mdrclient.MdrConnectionException - Todo.

de.samply.common.mdrclient.MdrInvalidResponseException - Todo.

ExecutionException - Todo.

getSlotValueLazyLoading

@Deprecated
public String getSlotValueLazyLoading(String slotKey)
                                            throws de.samply.common.mdrclient.MdrConnectionException,
                                                   ExecutionException,
                                                   de.samply.common.mdrclient.MdrInvalidResponseException,
                                                   MdrException

Deprecated.

Gets the slot value of a key, with lazyloading.

Parameters:

slotKey - the key

Returns:

the value

Throws:

de.samply.common.mdrclient.MdrConnectionException - Todo.

ExecutionException - Todo.

de.samply.common.mdrclient.MdrInvalidResponseException - Todo.

MdrException - Todo.

getSlotValues

public List<String> getSlotValues(String slotKey)
                           throws de.samply.common.mdrclient.MdrConnectionException,
                                  ExecutionException,
                                  de.samply.common.mdrclient.MdrInvalidResponseException,
                                  MdrException

Gets the slot values of a key.

Parameters:

slotKey - the key

Returns:

the values or null if there is no value for this slot

Throws:

de.samply.common.mdrclient.MdrConnectionException

ExecutionException

de.samply.common.mdrclient.MdrInvalidResponseException

MdrException

getSingleSlotValue

public String getSingleSlotValue(String slotKey)
                          throws de.samply.common.mdrclient.MdrConnectionException,
                                 ExecutionException,
                                 de.samply.common.mdrclient.MdrInvalidResponseException,
                                 MdrException

Gets the only slot value of a key.

Parameters:

slotKey - the key

Returns:

the value or null if there is no value for this slot

Throws:

MdrException - When there are more then one value for this slot.

de.samply.common.mdrclient.MdrConnectionException

ExecutionException

de.samply.common.mdrclient.MdrInvalidResponseException

getSlotValue

@Deprecated
public String getSlotValue(String slotKey)

Deprecated.

Gets the slot value of a key.

Parameters:

slotKey - the key

Returns:

the value or null if there is no value for this slot

getNamespace

public String getNamespace()

Gets the namespace.

Returns:

the namespace

setNamespace

public void setNamespace(String namespace)

Sets the namespace.

Parameters:

namespace - the namespace to set

getType

public de.samply.common.mdrclient.domain.EnumElementType getType()

Gets the type.

Returns:

the type

setType

public void setType(de.samply.common.mdrclient.domain.EnumElementType type)

Sets the type.

Parameters:

type - the type to set

getId

public String getId()

Gets the id.

Returns:

the id

setId

public void setId(String id)

Sets the id.

Parameters:

id - the id to set

getVersion

public String getVersion()

Gets the version.

Returns:

the version

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the version to set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isGroup

public boolean isGroup()

Checks if the mdrKey represents a dataelementgroup.

Returns:

true if it is a group.

compareTo

public int compareTo(MdrKey o)

Specified by:

compareTo in interface Comparable<MdrKey>

getKeyWithoutVersion

public String getKeyWithoutVersion()