Package com.priint.pubserver.comet.entity

Class CometProject

java.lang.Object

com.priint.pubserver.tagging.TaggingObject

com.priint.pubserver.comet.entity.CometEntity

com.priint.pubserver.comet.entity.CometProject

All Implemented Interfaces:

CometContextRuleConfiguration, Serializable

@CometTypeConstraints(calculateIds=false,
                      referenceBinding=NONE)
public class CometProject
extends CometEntity
implements CometContextRuleConfiguration

The type Comet project. Internal use only.

See Also:

• Serialized Form

Nested Class Summary

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
CometProject()	Instantiates a new Comet project.

Method Summary

Modifier and Type	Method	Description
boolean	canUseProjectDefault()	Can use project default boolean.
void	createNewRevision(String path)
String	getClient()	Gets client.
PluginMethod	getContextRuleAssortment()	Gets context rule assortment.
PluginMethod	getContextRuleCountry()	Gets context rule country.
PluginMethod	getContextRuleDocument()	Gets context rule document.
PluginMethod	getContextRuleLanguage()	Gets context rule language.
PluginMethod	getContextRuleMarketName()	Gets context rule market name.
PluginMethod	getContextRulePublication()	Gets context rule publication.
PluginMethod	getContextRuleTargetGroup()	Gets context rule target group.
PluginMethod	getContextRuleWell()	Gets context rule well.
String	getDescription()	Gets description.
String	getEntityModel()	Gets entity model.
List<com.priint.pubserver.comet.entity.CometProject.FileRevisionTracking>	getFileRevisionTrackings()
String	getIdentifier()	Gets identifier.
String	getLabel()	Gets label.
String	getPublicationProviderPlugin()	Gets publication provider plugin.
List<CometReference>	getReferenceConstraints()	Get reference (i.e.
String	getRepositoryFilename()	Gets the repository filename for this particular item
String	getRepositoryPath()	Get the relative repository path for this configuration type.
String	getRevisionOfFile(String path)
Boolean	getShowContent()	Gets show content.
boolean	getUseProjectDefault()	Gets use project default.
protected void	insertOrUpdateRevisionTracking(String path, String revision)
boolean	revisionMatches(String path, String repositoryRevision)	Checks, whether a revision of a repository file matches the expected tracked revision of the file
void	setClient(String client)	Sets client.
void	setContextRuleAssortment(PluginMethod contextRuleAssortment)	Sets context rule assortment.
void	setContextRuleCountry(PluginMethod contextRuleCountry)	Sets context rule country.
void	setContextRuleDocument(PluginMethod contextRuleDocument)	Sets context rule document.
void	setContextRuleLanguage(PluginMethod contextRuleLanguage)	Sets context rule language.
void	setContextRuleMarketName(PluginMethod contextRuleMarketName)	Sets context rule market name.
void	setContextRulePublication(PluginMethod contextRulePublication)	Sets context rule publication.
void	setContextRuleTargetGroup(PluginMethod contextRuleTargetGroup)	Sets context rule target group.
void	setContextRuleWell(PluginMethod contextRuleWell)	Sets context rule well.
void	setDescription(String description)	Sets description.
void	setEntityModel(String entityModel)	Sets entity model.
void	setFileRevisionTrackings(List<com.priint.pubserver.comet.entity.CometProject.FileRevisionTracking> fileRevisionTrackings)
void	setIdentifier(String identifier)	Sets identifier.
void	setLabel(String label)	Sets label.
void	setPublicationProviderPlugin(String publicationProviderPlugin)	Sets publication provider plugin.
void	setShowContent(Boolean showContent)	Sets show content.
void	setUseProjectDefault(boolean useProjectDefault)	Sets use project default.
void	updateToNextRevision(String path, String currentRevision)

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 Details

CometProject

public CometProject()

Instantiates a new Comet project.

Method Details

getClient

public String getClient()

Gets client.

Returns:

the client

getDescription

@CometDescription
public String getDescription()

Gets description.

Returns:

the description

getEntityModel

public String getEntityModel()

Gets entity model.

Returns:

the entity model

getIdentifier

public String getIdentifier()

Gets identifier.

Returns:

the identifier

getLabel

public String getLabel()

Gets label.

Returns:

the label

getReferenceConstraints

public 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 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 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

getShowContent

public Boolean getShowContent()

Gets show content.

Returns:

the show content

setClient

public void setClient(String client)

Sets client.

Parameters:

client - the client

setDescription

public void setDescription(String description)

Sets description.

Parameters:

description - the description

setEntityModel

public void setEntityModel(String entityModel)

Sets entity model.

Parameters:

entityModel - the entity model

setIdentifier

public void setIdentifier(String identifier)

Sets identifier.

Parameters:

identifier - the identifier

setLabel

public void setLabel(String label)

Sets label.

Parameters:

label - the label

setShowContent

public void setShowContent(Boolean showContent)

Sets show content.

Parameters:

showContent - the show content

getPublicationProviderPlugin

public String getPublicationProviderPlugin()

Gets publication provider plugin.

Returns:

the publication provider plugin

setPublicationProviderPlugin

public void setPublicationProviderPlugin(String publicationProviderPlugin)

Sets publication provider plugin.

Parameters:

publicationProviderPlugin - the publication provider plugin

getContextRuleAssortment

public PluginMethod getContextRuleAssortment()

Description copied from interface: CometContextRuleConfiguration

Gets context rule assortment.

Specified by:

getContextRuleAssortment in interface CometContextRuleConfiguration

Returns:

the context rule assortment

getContextRuleCountry

public PluginMethod getContextRuleCountry()

Description copied from interface: CometContextRuleConfiguration

Gets context rule country.

Specified by:

getContextRuleCountry in interface CometContextRuleConfiguration

Returns:

the context rule country

getContextRuleDocument

public PluginMethod getContextRuleDocument()

Description copied from interface: CometContextRuleConfiguration

Gets context rule document.

Specified by:

getContextRuleDocument in interface CometContextRuleConfiguration

Returns:

the context rule document

getContextRuleLanguage

public PluginMethod getContextRuleLanguage()

Description copied from interface: CometContextRuleConfiguration

Gets context rule language.

Specified by:

getContextRuleLanguage in interface CometContextRuleConfiguration

Returns:

the context rule language

getContextRulePublication

public PluginMethod getContextRulePublication()

Description copied from interface: CometContextRuleConfiguration

Gets context rule publication.

Specified by:

getContextRulePublication in interface CometContextRuleConfiguration

Returns:

the context rule publication

getContextRuleWell

public PluginMethod getContextRuleWell()

Description copied from interface: CometContextRuleConfiguration

Gets context rule well.

Specified by:

getContextRuleWell in interface CometContextRuleConfiguration

Returns:

the context rule well

getContextRuleTargetGroup

public PluginMethod getContextRuleTargetGroup()

Description copied from interface: CometContextRuleConfiguration

Gets context rule target group.

Specified by:

getContextRuleTargetGroup in interface CometContextRuleConfiguration

Returns:

the context rule target group

getContextRuleMarketName

public PluginMethod getContextRuleMarketName()

Description copied from interface: CometContextRuleConfiguration

Gets context rule market name.

Specified by:

getContextRuleMarketName in interface CometContextRuleConfiguration

Returns:

the context rule market name

setContextRuleAssortment

public void setContextRuleAssortment(PluginMethod contextRuleAssortment)

Description copied from interface: CometContextRuleConfiguration

Sets context rule assortment.

Specified by:

setContextRuleAssortment in interface CometContextRuleConfiguration

Parameters:

contextRuleAssortment - the context rule assortment

setContextRuleCountry

public void setContextRuleCountry(PluginMethod contextRuleCountry)

Description copied from interface: CometContextRuleConfiguration

Sets context rule country.

Specified by:

setContextRuleCountry in interface CometContextRuleConfiguration

Parameters:

contextRuleCountry - the context rule country

setContextRuleDocument

public void setContextRuleDocument(PluginMethod contextRuleDocument)

Description copied from interface: CometContextRuleConfiguration

Sets context rule document.

Specified by:

setContextRuleDocument in interface CometContextRuleConfiguration

Parameters:

contextRuleDocument - the context rule document

setContextRuleLanguage

public void setContextRuleLanguage(PluginMethod contextRuleLanguage)

Description copied from interface: CometContextRuleConfiguration

Sets context rule language.

Specified by:

setContextRuleLanguage in interface CometContextRuleConfiguration

Parameters:

contextRuleLanguage - the context rule language

setContextRulePublication

public void setContextRulePublication(PluginMethod contextRulePublication)

Description copied from interface: CometContextRuleConfiguration

Sets context rule publication.

Specified by:

setContextRulePublication in interface CometContextRuleConfiguration

Parameters:

contextRulePublication - the context rule publication

setContextRuleWell

public void setContextRuleWell(PluginMethod contextRuleWell)

Description copied from interface: CometContextRuleConfiguration

Sets context rule well.

Specified by:

setContextRuleWell in interface CometContextRuleConfiguration

Parameters:

contextRuleWell - the context rule well

setContextRuleTargetGroup

public void setContextRuleTargetGroup(PluginMethod contextRuleTargetGroup)

Description copied from interface: CometContextRuleConfiguration

Sets context rule target group.

Specified by:

setContextRuleTargetGroup in interface CometContextRuleConfiguration

Parameters:

contextRuleTargetGroup - the context rule target group

setContextRuleMarketName

public void setContextRuleMarketName(PluginMethod contextRuleMarketName)

Description copied from interface: CometContextRuleConfiguration

Sets context rule market name.

Specified by:

setContextRuleMarketName in interface CometContextRuleConfiguration

Parameters:

contextRuleMarketName - the context rule market name

canUseProjectDefault

public boolean canUseProjectDefault()

Description copied from interface: CometContextRuleConfiguration

Can use project default boolean.

Specified by:

canUseProjectDefault in interface CometContextRuleConfiguration

Returns:

the boolean

getUseProjectDefault

public boolean getUseProjectDefault()

Description copied from interface: CometContextRuleConfiguration

Gets use project default.

Specified by:

getUseProjectDefault in interface CometContextRuleConfiguration

Returns:

the use project default

setUseProjectDefault

public void setUseProjectDefault(boolean useProjectDefault)

Description copied from interface: CometContextRuleConfiguration

Sets use project default.

Specified by:

setUseProjectDefault in interface CometContextRuleConfiguration

Parameters:

useProjectDefault - the use project default

getFileRevisionTrackings

public List<com.priint.pubserver.comet.entity.CometProject.FileRevisionTracking> getFileRevisionTrackings()

setFileRevisionTrackings

public void setFileRevisionTrackings(List<com.priint.pubserver.comet.entity.CometProject.FileRevisionTracking> fileRevisionTrackings)

getRevisionOfFile

public String getRevisionOfFile(String path)

insertOrUpdateRevisionTracking

protected void insertOrUpdateRevisionTracking(String path,
 String revision)

createNewRevision

public void createNewRevision(String path)

updateToNextRevision

public void updateToNextRevision(String path,
 String currentRevision)

revisionMatches

public boolean revisionMatches(String path,
 String repositoryRevision)

Checks, whether a revision of a repository file matches the expected tracked revision of the file

A revision matches, if

• the tracked revision is null. This means: we just start tracking revisions for this file. OR
• the repository revision is null. This means: no repository file exists yet OR
• the repository revision is equal to the tracked revision.

Parameters:

path - path of the repository file

repositoryRevision - the revision of the file in the repository or null, if the file does not exiut yet

Returns:

true, if revisions match (according to the rules stated above), false otherwise