Package com.priint.pubserver.comet.entity

Class CometEntity

java.lang.Object

com.priint.pubserver.tagging.TaggingObject

com.priint.pubserver.comet.entity.CometEntity

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CometBinary, CometColor, CometFindStatement.Sourcefile, CometFrameInfoDocument, CometGrid, CometGrid.Element, CometGrid.Spread, CometGridType, CometIndex, CometPageTemplate, CometPageTemplate.BBox, CometPageTemplate.Id, CometPageTemplateElementPredefinedMetadata, CometPageTemplateMetadata, CometPageTemplatePredefinedMetadata, CometPlaceholder, CometPlaceholderGroup, CometPlaceholderGroup.Placeholder, CometPlaceholderVariant, CometProductPanelConfig, CometProject, CometSetting, CometSnippetDocument, CometStatement, CometTemplate, CometTemplate.Record, CometTemplate.Spread, CometTemplateGroup, CometTocUpdate, ScriptExample

@CometTypeConstraints(dependencies=@CometReferences(references=@CometReference(restriction=PARENT,targetClass=CometIndex.class)))
public class CometEntity
extends TaggingObject
implements java.io.Serializable

Base type for all Comet configuration entities

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CometEntity.Category	The enum Category.

Nested classes/interfaces inherited from class com.priint.pubserver.tagging.TaggingObject

TaggingObject.LinkedSetWrapper<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	id	The Id.
static java.lang.String	TAG_DOMAIN_QUALIFIER	The constant TAG_DOMAIN_QUALIFIER.
static java.lang.String	TAG_GROUP_QUALIFIER	The constant TAG_GROUP_QUALIFIER.
static java.lang.String	TAG_TYPE_QUALIFIER	The constant TAG_TYPE_QUALIFIER.

Fields inherited from class com.priint.pubserver.tagging.TaggingObject

tagsSet

Constructor Summary

Constructors

Constructor	Description
CometEntity()	Instantiates a new Comet entity.
CometEntity(int id)	Instantiates a new Comet entity.

Method Summary

Modifier and Type	Method	Description
void	checkMinimalConstraints()	Check minimal constraints.
boolean	entityEquals(CometEntity other)	Entity equals boolean.
boolean	equals(java.lang.Object other)
java.lang.String	getEntityDescription()	Gets entity description.
java.lang.String	getEntityLabel()	Gets entity label.
int	getId()	Gets id.
java.util.List<CometReference>	getReferenceConstraints()	Get reference (i.e.
java.lang.String	getRepositoryFilename()	Gets the repository filename for this particular item
java.lang.String	getRepositoryPath()	Get the relative repository path for this configuration type.
int	hashCode()
CometEntity	initDefaultValues()	Init default values comet entity.
CometEntity	initDefaultValues(java.util.Map<java.lang.String,java.lang.Object> initialValues)	Init default values comet entity.
void	setId(int id)	Sets id.

Methods inherited from class com.priint.pubserver.tagging.TaggingObject

addToTags, getTags, getTagValue, inTags, isA, removeFromTags, searchListByTags, setTags, setTags

Methods inherited from class java.lang.Object

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

Field Detail

TAG_TYPE_QUALIFIER

public static final java.lang.String TAG_TYPE_QUALIFIER

The constant TAG_TYPE_QUALIFIER.

See Also:

Constant Field Values

TAG_GROUP_QUALIFIER

public static final java.lang.String TAG_GROUP_QUALIFIER

The constant TAG_GROUP_QUALIFIER.

See Also:

Constant Field Values

TAG_DOMAIN_QUALIFIER

public static final java.lang.String TAG_DOMAIN_QUALIFIER

The constant TAG_DOMAIN_QUALIFIER.

See Also:

Constant Field Values

id

@CometId
protected int id

The Id.

Constructor Detail

CometEntity

public CometEntity()

Instantiates a new Comet entity.

CometEntity

public CometEntity(int id)

Instantiates a new Comet entity.

Parameters:

id - the id

Method Detail

checkMinimalConstraints

public void checkMinimalConstraints()
                             throws CometException

Check minimal constraints.

Throws:

CometException - the comet exception

entityEquals

public boolean entityEquals(CometEntity other)

Entity equals boolean.

Parameters:

other - the other

Returns:

the boolean

equals

public final boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getEntityDescription

public final java.lang.String getEntityDescription()

Gets entity description.

Returns:

the entity description

getEntityLabel

public final java.lang.String getEntityLabel()

Gets entity label.

Returns:

the entity label

getId

public int getId()

Gets id.

Returns:

the id

getReferenceConstraints

public java.util.List<CometReference> getReferenceConstraints()

Get reference (i.e. PluginDependency) constraints for this type, including constraints inherited from super classes

See the CometTypeConstraints annotation for more information

Returns:

list of mandatory dependencies for this type

getRepositoryFilename

public java.lang.String getRepositoryFilename()
                                       throws CometException

Gets the repository filename for this particular item

This method MUST be overridden by classes extending CometEntity

Returns:

the repository filename of this particular item

Throws:

CometException - the comet exception

getRepositoryPath

public java.lang.String getRepositoryPath()
                                   throws CometException

Get the relative repository path for this configuration type.

This method MUST be overridden by classes extending CometEntity.

Returns:

relative repository path

Throws:

CometException - the comet exception

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

initDefaultValues

public CometEntity initDefaultValues()

Init default values comet entity.

Returns:

the comet entity

initDefaultValues

public CometEntity initDefaultValues(java.util.Map<java.lang.String,java.lang.Object> initialValues)
                              throws CometException

Init default values comet entity.

Parameters:

initialValues - the initial values

Returns:

the comet entity

Throws:

CometException - the comet exception

setId

public void setId(int id)

Sets id.

Parameters:

id - the id