Package com.priint.pubserver.comet.entity

Class CometIndex

java.lang.Object

com.priint.pubserver.tagging.TaggingObject

com.priint.pubserver.comet.entity.CometEntity

com.priint.pubserver.comet.entity.CometIndex

All Implemented Interfaces:

java.io.Serializable

@CometTypeConstraints(calculateIds=false,
                      referenceBinding=NONE,
                      dependencies=@CometReferences(references=@CometReference(restriction=PARENT,targetClass=CometProject.class)))
public class CometIndex
extends CometEntity

The type Comet index. Internal use only.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CometIndex.CometIndexEntry	The type Comet index entry.

Nested classes/interfaces inherited from class com.priint.pubserver.comet.entity.CometEntity

CometEntity.Category

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

TaggingObject.LinkedSetWrapper<T>

Field Summary

Fields inherited from class com.priint.pubserver.comet.entity.CometEntity

id, TAG_DOMAIN_QUALIFIER, TAG_GROUP_QUALIFIER, TAG_TYPE_QUALIFIER

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

tagsSet

Constructor Summary

Constructors

Constructor	Description
CometIndex()	Instantiates a new Comet index.

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateEntry(java.lang.String label, java.lang.String path)	Add or update entry.
java.util.List<CometIndex.CometIndexEntry>	getItems()	Gets items.
java.lang.String	getLabel()	Gets label.
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.
void	removeEntry(java.lang.String path)	Remove entry.
void	setItems(java.util.List<CometIndex.CometIndexEntry> items)	Sets items.
void	setLabel(java.lang.String label)	Sets label.

Methods inherited from class com.priint.pubserver.comet.entity.CometEntity

checkMinimalConstraints, entityEquals, equals, getEntityDescription, getEntityLabel, getId, hashCode, initDefaultValues, initDefaultValues, setId

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

Constructor Detail

CometIndex

public CometIndex()

Instantiates a new Comet index.

Method Detail

addOrUpdateEntry

public void addOrUpdateEntry(java.lang.String label,
                             java.lang.String path)

Add or update entry.

Parameters:

label - the label

path - the path

getItems

public java.util.List<CometIndex.CometIndexEntry> getItems()

Gets items.

Returns:

the items

getLabel

public java.lang.String getLabel()

Gets label.

Returns:

the label

getReferenceConstraints

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

Description copied from class: CometEntity

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

See the CometTypeConstraints annotation for more information

Overrides:

getReferenceConstraints in class CometEntity

Returns:

list of mandatory dependencies for this type

getRepositoryFilename

public java.lang.String getRepositoryFilename()
                                       throws CometException

Description copied from class: CometEntity

Gets the repository filename for this particular item

This method MUST be overridden by classes extending CometEntity

Overrides:

getRepositoryFilename in class CometEntity

Returns:

the repository filename of this particular item

Throws:

CometException - the comet exception

getRepositoryPath

public java.lang.String getRepositoryPath()
                                   throws CometException

Description copied from class: CometEntity

Get the relative repository path for this configuration type.

This method MUST be overridden by classes extending CometEntity.

Overrides:

getRepositoryPath in class CometEntity

Returns:

relative repository path

Throws:

CometException - the comet exception

removeEntry

public void removeEntry(java.lang.String path)

Remove entry.

Parameters:

path - the path

setItems

public void setItems(java.util.List<CometIndex.CometIndexEntry> items)

Sets items.

Parameters:

items - the items

setLabel

public void setLabel(java.lang.String label)

Sets label.

Parameters:

label - the label