Package com.priint.pubserver.plugin.entitydata

Class Text

java.lang.Object

com.priint.pubserver.plugin.entitydata.Text

All Implemented Interfaces:

GetContext, GetIdentifier, GetSequence, EntityData, PersistentData, Serializable

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

Data object of entity type Text

Text elements are used to represent textual content of content systems.

Since:

4.0.0, 4.0.5 origin attribute supported, added JPA annotations, getLanguage() and getCountry() are deprecated

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Text.properties

Constructor Summary

Constructors

Constructor	Description
Text()	Default constructor.
Text(String identifier, String entityTextId, Context context, String bucketId, String text, String createdBy, Date createdOn, String updatedBy, Date updatedOn)	Create a Text with extended properties set.
Text(String identifier, String entityTextId, String text, Context context, Bucket bucket)	Create a Text with basic properties set.

Method Summary

Modifier and Type	Method	Description
Bucket	getBucket()
String	getBucketId()
ConnectorEntity	getConnectorEntity()
List<ContentMetaData>	getContentMetaData()
Context	getContext()	Get the context for this element or null if not set.
String	getCreatedBy()
Date	getCreatedOn()
EntityText	getEntity()
String	getEntityIdentifier()	Identifier of an entity in the entity model where the current object refers to.
String	getEntityTextId()
String	getGroupIdentifier()	String key for grouping texts of the same type.
String	getIdentifier()	Get the string identifier of the text.
MediaAsset	getMediaAsset()
List<KeyValue>	getMetaData()
String	getOrigin()
int	getSequence()	Get sequence number for the text as given in the content system.
String	getTemplate()
String	getText()
String	getTimestamp()	Get timestamp from the content system.
String	getUpdatedBy()
Date	getUpdatedOn()
String	getVersion()	Version string from the content system
void	setBucket(Bucket bucket)
void	setBucketId(String bucketId)
void	setConnectorEntity(ConnectorEntity connectorEntity)
void	setContentMetaData(List<ContentMetaData> contentMetaData)
void	setContext(Context context)	set the context of entity data object
void	setCreatedBy(String createdBy)
void	setCreatedOn(Date createdOn)
void	setEntity(EntityText entityText)	Set entityText and entityTextId.
void	setEntityIdentifier(String entityIdentifier)	Identifier of an entity in the entity model where the current object refers to.
void	setEntityTextId(String entityTextId)	Set entity identifier and remove entity object of not matching this identifier.
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setMediaAsset(MediaAsset mediaAsset)
void	setMetaData(List<KeyValue> metaData)
void	setOrigin(String origin)
void	setSequence(int sequence)
void	setTemplate(String template)
void	setText(String text)
void	setTimestamp(String timestamp)
void	setUpdatedBy(String updatedBy)
void	setUpdatedOn(Date updatedOn)
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

Text

public Text()

Default constructor.

Text

public Text(String identifier,
 String entityTextId,
 String text,
 Context context,
 Bucket bucket)

Create a Text with basic properties set.

Parameters:

identifier - getIdentifier()

entityTextId - getEntityTextId()

text - getText()

context - getContext()

bucket - getBucket()

Text

public Text(String identifier,
 String entityTextId,
 Context context,
 String bucketId,
 String text,
 String createdBy,
 Date createdOn,
 String updatedBy,
 Date updatedOn)

Create a Text with extended properties set.

Parameters:

identifier - getIdentifier()

entityTextId - getEntityTextId()

context - getContext()

bucketId - getBucketId()

text - getText()

createdBy - getCreatedBy()

createdOn - getCreatedOn()

updatedBy - getUpdatedBy()

updatedOn - getUpdatedOn()

Method Details

getIdentifier

public String getIdentifier()

Get the string identifier of the text.

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 texts 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()

getEntity

public EntityText getEntity()

Returns:

Text entity object associated with the current text or null if not set.

See Also:

• getEntityTextId()

setEntity

public void setEntity(EntityText entityText)

Set entityText and entityTextId.

Parameters:

entityText - see getEntity()

getText

public String getText()

Returns:

Text content of this element.

setText

public void setText(String text)

Parameters:

text - getText()

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 text is related to.

setBucket

public void setBucket(Bucket bucket)

Parameters:

bucket - getBucket()

getSequence

public int getSequence()

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

This should reflect the position of the current text in the sorting of texts of its sourceBucket.

Specified by:

getSequence in interface GetSequence

Returns:

ordered position within a list sequenceable objects

setSequence

public void setSequence(int sequence)

Parameters:

sequence - see getSequence()

getConnectorEntity

public ConnectorEntity getConnectorEntity()

Returns:

connector entity object or null if not set

setConnectorEntity

public void setConnectorEntity(ConnectorEntity connectorEntity)

Parameters:

connectorEntity - see getConnectorEntity()

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()

getEntityTextId

public String getEntityTextId()

Returns:

Identifier of related entity in entity model or null if not set.

setEntityTextId

public void setEntityTextId(String entityTextId)

Set entity identifier and remove entity object of not matching this identifier.

Parameters:

entityTextId - getEntityTextId()

getBucketId

public String getBucketId()

Returns:

Identifier of parent bucket that this content element is related to. Is null for following methods:
EntityManagerRemote.getEntityTextsByIdentifier(String, String, String, String, Context, String) EntityManagerRemote.getEntityTextsOfBucket(String, String, String, String, String, Context, String) EntityManagerRemote.getEntityTextsOfPlanning(String, String, String, String, String, Context, String, String) EntityManagerRemote.getEntityTextsOfPlannedBucket(String, String, String, String, Context, String)

setBucketId

public void setBucketId(String bucketId)

Parameters:

bucketId - getBucketId()

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()

getMediaAsset

public MediaAsset getMediaAsset()

Returns:

MediaAsset. Is null for following methods:
* EntityManagerRemote.getEntityTextsByIdentifier(String, String, String, String, Context, String) * EntityManagerRemote.getEntityTextsOfBucket(String, String, String, String, String, Context, String) * EntityManagerRemote.getEntityTextsOfPlanning(String, String, String, String, String, Context, String, String) * EntityManagerRemote.getEntityTextsOfPlannedBucket(String, String, String, String, Context, String)

setMediaAsset

public void setMediaAsset(MediaAsset mediaAsset)

toString

public String toString()

Overrides:

toString in class Object

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 Text.

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()