Package com.priint.pubserver.plugin.entitydata

Class KeyValue

java.lang.Object

com.priint.pubserver.plugin.entitydata.KeyValue

All Implemented Interfaces:

GetContext, GetIdentifier, GetSequence, EntityData, PersistentData, Serializable

@Entity
public class KeyValue
extends Object
implements Serializable, GetContext, GetIdentifier, GetSequence, EntityData, PersistentData

Data object for entity type KeyValue

KeyValue data are used for example for technical attributes of a product like weight, or size etc.

Since:

4.0.0, 4.0.5 origin attribute supported, parentKeyValue and refKeyValue are to be referenced and not included, added JPA annotations, getLanguage() and getCountry() are deprecated

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KeyValue.properties

Constructor Summary

Constructors

Constructor	Description
KeyValue()	Default constructor.
KeyValue(String identifier, String key, String value, String dataType, String entityKeyValueId, Context context, Bucket bucket)	Creates a KeyValue
KeyValue(String identifier, String key, String keyLabel, String value, String dataType, String entityKeyValueId, Context context, String bucketId, String createdBy, Date createdOn, String updatedBy, Date updatedOn)

Method Summary

Modifier and Type	Method	Description
Bucket	getBucket()
String	getBucketId()
Bucket	getBucketMetaData()
ConnectorEntity	getConnectorEntity()
List<ContentMetaData>	getContentMetaData()
Context	getContext()	Get the context for this element or null if not set.
Cord	getCord()
String	getCreatedBy()
Date	getCreatedOn()
String	getDataType()
EntityKeyValue	getEntity()
String	getEntityIdentifier()	Identifier of an entity in the entity model where the current object refers to.
String	getEntityKeyValueId()
String	getGroupIdentifier()	String key for grouping key values of the same type.
String	getIdentifier()	Get the string identifier of the keyvalue.
String	getKey()
String	getKeyLabel()
String	getKeySymbol()
MediaAsset	getMediaAsset()
MediaObject	getMediaObject()
List<KeyValue>	getMetaData()
KeyValue	getMetaDataParent()
String	getOrigin()
KeyValue	getParentKeyValue()
final String	getParentKeyValueId()
Price	getPrice()
KeyValue	getRefKeyValue()
final String	getRefKeyValueId()
int	getSequence()	Get sequence number for the keyvalue as given in the content system.
String	getSource()
List<KeyValue>	getSubKeyValues()
TableDataCell	getTableCell()
TableData	getTableData()
TableDataRow	getTableRow()
String	getTemplate()
Text	getText()
String	getTimestamp()	Get timestamp from the content system.
String	getUpdatedBy()
Date	getUpdatedOn()
String	getValue()
String	getVersion()	Version string from the content system
void	setBucket(Bucket bucket)	Sets bucket and bucketId.
void	setBucketId(String bucketId)	Sets bucketId and eventually removes current bucket if it does not match the id
void	setBucketMetaData(Bucket bucketMetaData)
void	setConnectorEntity(ConnectorEntity connectorEntity)
void	setContentMetaData(List<ContentMetaData> contentMetaData)
void	setContext(Context context)	set the context of entity data object
void	setCord(Cord cord)
void	setCreatedBy(String createdBy)
void	setCreatedOn(Date createdOn)
void	setDataType(String dataType)
void	setEntity(EntityKeyValue entityKeyValue)	Sets entityKeyValue and entityKeyValueId.
void	setEntityIdentifier(String entityIdentifier)	Identifier of an entity in the entity model where the current object refers to.
void	setEntityKeyValueId(String entityKeyValueId)	Sets entityKeyValueId and eventually removes current entityKeyValue if it does not match the id
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setKey(String key)
void	setKeyLabel(String keyLabel)
void	setKeySymbol(String keySymbol)
void	setMediaAsset(MediaAsset mediaAsset)
void	setMediaObject(MediaObject mediaObject)
void	setMetaData(List<KeyValue> metaData)
void	setMetaDataParent(KeyValue metaDataParent)
void	setOrigin(String origin)
void	setParentKeyValue(KeyValue parentKeyValue)
final void	setParentKeyValueId(String parentKeyValueId)	Sets parentKeyValueId and eventually removes current parentKeyValue if it does not match the id
void	setPrice(Price price)
void	setRefKeyValue(KeyValue refKeyValue)
final void	setRefKeyValueId(String refKeyValueId)	Sets refKeyValueId and eventually removes current refKeyValue if it does not match the id
void	setSequence(int sequence)
void	setSource(String source)
void	setSubKeyValues(List<KeyValue> subKeyValues)
void	setTableCell(TableDataCell tableCell)
void	setTableData(TableData tableData)
void	setTableRow(TableDataRow tableRow)
void	setTemplate(String template)
void	setText(Text text)
void	setTimestamp(String timestamp)
void	setUpdatedBy(String updatedBy)
void	setUpdatedOn(Date updatedOn)
void	setValue(String value)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KeyValue

public KeyValue()

Default constructor.

KeyValue

public KeyValue(String identifier,
 String key,
 String value,
 String dataType,
 String entityKeyValueId,
 Context context,
 Bucket bucket)

Creates a KeyValue

Parameters:

identifier - getIdentifier()

key - getKey()

value - getValue()

dataType - getDataType()

entityKeyValueId - getEntityKeyValueId()

context - getContext()

bucket - getBucket()

KeyValue

public KeyValue(String identifier,
 String key,
 String keyLabel,
 String value,
 String dataType,
 String entityKeyValueId,
 Context context,
 String bucketId,
 String createdBy,
 Date createdOn,
 String updatedBy,
 Date updatedOn)

Parameters:

identifier - getIdentifier()

key - getKey()

keyLabel - getKeyLabel()

value - getValue()

dataType - getDataType()

entityKeyValueId - getEntityKeyValueId()

context - getContext()

bucketId - getBucketId()

createdBy - getCreatedBy()

createdOn - getCreatedOn()

updatedBy - getUpdatedBy()

updatedOn - getUpdatedOn()

Method Details

getIdentifier

public String getIdentifier()

Get the string identifier of the keyvalue.

Specified by:

getIdentifier in interface EntityData

Specified by:

getIdentifier in interface GetIdentifier

Specified by:

getIdentifier in interface PersistentData

Returns:

identifier string or null if not set

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface EntityData

Parameters:

identifier - see getIdentifier()

getGroupIdentifier

public String getGroupIdentifier()

String key for grouping key values of the same type.

Returns:

group identifier string or null if not set

setGroupIdentifier

public void setGroupIdentifier(String groupIdentifier)

Parameters:

groupIdentifier - see getGroupIdentifier()

getVersion

public String getVersion()

Version string from the content system

Returns:

version string or null if not set

setVersion

public void setVersion(String version)

Parameters:

version - see getVersion()

getTimestamp

public String getTimestamp()

Get timestamp from the content system.

Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.

Returns:

timestamp string

setTimestamp

public void setTimestamp(String timestamp)

Parameters:

timestamp - see getTimestamp()

getTemplate

public String getTemplate()

Returns:

String identifier of the template to render this content.

setTemplate

public void setTemplate(String template)

Parameters:

template - getTemplate()

getConnectorEntity

public ConnectorEntity getConnectorEntity()

Returns:

connector entity object or null if not set

setConnectorEntity

public void setConnectorEntity(ConnectorEntity connectorEntity)

Parameters:

connectorEntity - see getConnectorEntity()

getKey

public String getKey()

Returns:

Name of the key, e.g. "length"

setKey

public void setKey(String key)

Parameters:

key - getKey()

getKeyLabel

public String getKeyLabel()

Returns:

Label for the key. Used for publishing, if key itself is something like a code.

setKeyLabel

public void setKeyLabel(String keyLabel)

Parameters:

keyLabel - getKeyLabel()

getValue

public String getValue()

Returns:

Value of the key-value object, e.g. "12.3" for a key named "length".

Value is always a string. You may use dataType property for specifying the preferred type.

setValue

public void setValue(String value)

Parameters:

value - getValue()

getDataType

public String getDataType()

Returns:

Data type of the value (String, int, float, boolean).

There is no vocabulary explicitly restricting the values of this property.

setDataType

public void setDataType(String dataType)

Parameters:

dataType - getDataType()

getSource

public String getSource()

Returns:

origin of the KeyValue, i.e. whether it comes from the connector or entity manager.

This property is set from the publishing server.

setSource

public void setSource(String source)

Parameters:

source - getSource()

getSequence

public int getSequence()

Get sequence number for the keyvalue as given in the content system.

This should reflect the position of the current keyvalue in the sorting of keyvalues of its bucket.

Specified by:

getSequence in interface GetSequence

Returns:

ordered position within a list sequenceable objects

setSequence

public void setSequence(int sequence)

Parameters:

sequence - see getSequence()

getRefKeyValue

public KeyValue getRefKeyValue()

Returns:

link to a referenced keyValue (like "Kilogramm")

setRefKeyValue

public void setRefKeyValue(KeyValue refKeyValue)

Parameters:

refKeyValue - getRefKeyValue()

getParentKeyValue

public KeyValue getParentKeyValue()

Returns:

link to parent KeyValue

setParentKeyValue

public void setParentKeyValue(KeyValue parentKeyValue)

Parameters:

parentKeyValue - getParentKeyValue()

getEntity

public EntityKeyValue getEntity()

Returns:

Entity from Entity Model

setEntity

public void setEntity(EntityKeyValue entityKeyValue)

Sets entityKeyValue and entityKeyValueId.

Parameters:

entityKeyValue - getEntity()

See Also:

• setEntityKeyValueId(String)

getContext

public Context getContext()

Get the context for this element or null if not set.

Specified by:

getContext in interface EntityData

Specified by:

getContext in interface GetContext

Returns:

context

setContext

public void setContext(Context context)

Description copied from interface: EntityData

set the context of entity data object

Specified by:

setContext in interface EntityData

Parameters:

context - getContext()

getBucket

public Bucket getBucket()

Returns:

Parent bucket that this keyValue is related to.

setBucket

public void setBucket(Bucket bucket)

Sets bucket and bucketId.

Parameters:

bucket - getBucket()

See Also:

• setBucketId(String)

getMetaData

public List<KeyValue> getMetaData()

Returns:

List of meta data related to the bucket or empty list.

List is LAZY loaded.

setMetaData

public void setMetaData(List<KeyValue> metaData)

Parameters:

metaData - see getMetaData()

getSubKeyValues

public List<KeyValue> getSubKeyValues()

Returns:

List of KeyValues related to KeyValue.

List is LAZY loaded.

setSubKeyValues

public void setSubKeyValues(List<KeyValue> subKeyValues)

Parameters:

subKeyValues - getSubKeyValues()

getEntityKeyValueId

public String getEntityKeyValueId()

Returns:

Identifier of related entity in entity model.

setEntityKeyValueId

public void setEntityKeyValueId(String entityKeyValueId)

Sets entityKeyValueId and eventually removes current entityKeyValue if it does not match the id

Parameters:

entityKeyValueId - getEntityKeyValueId()

getBucketId

public String getBucketId()

Returns:

Identifier of parent bucket that this content element is related to. Is null for following methods:
EntityManagerRemote.getEntityKeyValuesOfBucket(String, String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesByIdentifier(String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesOfPlanning(String, String, String, String, String, Context, String, String) } EntityManagerRemote.getEntityKeyValuesOfPlannedBucket(String, String, String, String, Context, String) }

setBucketId

public void setBucketId(String bucketId)

Sets bucketId and eventually removes current bucket if it does not match the id

Parameters:

bucketId - getBucketId()

getKeySymbol

public String getKeySymbol()

Returns:

Symbol for key

setKeySymbol

public void setKeySymbol(String keySymbol)

Parameters:

keySymbol - getKeySymbol()

getCreatedBy

public String getCreatedBy()

Returns:

creation user or null if not set

setCreatedBy

public void setCreatedBy(String createdBy)

Parameters:

createdBy - see getCreatedBy()

getCreatedOn

public Date getCreatedOn()

Returns:

creation date or null if not set

setCreatedOn

public void setCreatedOn(Date createdOn)

Parameters:

createdOn - see getCreatedOn()

getUpdatedBy

public String getUpdatedBy()

Returns:

last modified user or null if not set

setUpdatedBy

public void setUpdatedBy(String updatedBy)

Parameters:

updatedBy - see getUpdatedBy()

getUpdatedOn

public Date getUpdatedOn()

Returns:

last modified date or null if not set

setUpdatedOn

public void setUpdatedOn(Date updatedOn)

Parameters:

updatedOn - see getUpdatedOn()

getText

public Text getText()

setText

public void setText(Text text)

getTableData

public TableData getTableData()

setTableData

public void setTableData(TableData tableData)

getMediaObject

public MediaObject getMediaObject()

setMediaObject

public void setMediaObject(MediaObject mediaObject)

getPrice

public Price getPrice()

setPrice

public void setPrice(Price price)

getMediaAsset

public MediaAsset getMediaAsset()

setMediaAsset

public void setMediaAsset(MediaAsset mediaAsset)

getMetaDataParent

public KeyValue getMetaDataParent()

setMetaDataParent

public void setMetaDataParent(KeyValue metaDataParent)

getCord

public Cord getCord()

setCord

public void setCord(Cord cord)

getTableRow

public TableDataRow getTableRow()

setTableRow

public void setTableRow(TableDataRow tableRow)

getBucketMetaData

public Bucket getBucketMetaData()

setBucketMetaData

public void setBucketMetaData(Bucket bucketMetaData)

getTableCell

public TableDataCell getTableCell()

setTableCell

public void setTableCell(TableDataCell tableCell)

toString

public String toString()

Overrides:

toString in class Object

getRefKeyValueId

public final String getRefKeyValueId()

Returns:

Identifier of related keyValue, e.g. a unit. Is null for following methods:
EntityManagerRemote.getEntityKeyValuesOfBucket(String, String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesByIdentifier(String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesOfPlanning(String, String, String, String, String, Context, String, String) } EntityManagerRemote.getEntityKeyValuesOfPlannedBucket(String, String, String, String, Context, String) }

setRefKeyValueId

public final void setRefKeyValueId(String refKeyValueId)

Sets refKeyValueId and eventually removes current refKeyValue if it does not match the id

Parameters:

refKeyValueId - getRefKeyValueId()

getParentKeyValueId

public final String getParentKeyValueId()

Returns:

Identifier of parent keyValue. Is null for following methods:
EntityManagerRemote.getEntityKeyValuesOfBucket(String, String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesByIdentifier(String, String, String, String, Context, String) EntityManagerRemote.getEntityKeyValuesOfPlanning(String, String, String, String, String, Context, String, String) } EntityManagerRemote.getEntityKeyValuesOfPlannedBucket(String, String, String, String, Context, String) }

setParentKeyValueId

public final void setParentKeyValueId(String parentKeyValueId)

Sets parentKeyValueId and eventually removes current parentKeyValue if it does not match the id

Parameters:

parentKeyValueId - getParentKeyValueId()

getOrigin

public String getOrigin()

Returns:

Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return null.

setOrigin

public void setOrigin(String origin)

Parameters:

origin - getOrigin()

getEntityIdentifier

public String getEntityIdentifier()

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

getEntityIdentifier in interface EntityData

Returns:

entity identifier as string

setEntityIdentifier

public void setEntityIdentifier(String entityIdentifier)

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

setEntityIdentifier in interface EntityData

getContentMetaData

public List<ContentMetaData> getContentMetaData()

Returns:

List of ContentMetaData related to KeyValue.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setContentMetaData

public void setContentMetaData(List<ContentMetaData> contentMetaData)

Parameters:

contentMetaData - getContentMetaData()