Package ch.tocco.nice2.dms.impl.entitydocs

Class EntityDocumentsServiceImpl

java.lang.Object

ch.tocco.nice2.dms.impl.entitydocs.EntityDocumentsServiceImpl

All Implemented Interfaces:

EntityDocumentsService, InternalEntityDocumentsService

@Component
public class EntityDocumentsServiceImpl
extends Object
implements InternalEntityDocumentsService

Constructor Summary

Constructors

Constructor

Description

EntityDocumentsServiceImpl(TypeManager typeManager, Context context, DataModel dataModel, QueryBuilderFactory queryBuilderFactory, ContentTreeService contentTreeService, CommandExecutor commandExecutor, TimezoneResolverService timezoneResolverService, SecurityManager securityManager, DefaultDisplayService defaultDisplayService, BusinessUnitManager businessUnitManager, org.slf4j.Logger log, L10N l10N)

Method Summary

Modifier and Type	Method	Description
String	addTimestampToFilename(String fileName)
FolderNode	createEntityDocumentsFolder(Entity entity, FolderNode parentFolder)	Create an entity's document folder.
Invoker	createEntityDocumentsInvoker(List<EntityId> entities)
FolderNode	ensureEntityModelFolder(EntityModel entityModel)
void	ensureLanguageFolders(FolderNode parentFolder)	make sure all language folders exist in the parent folder
String	getDetailDocumentFileName(ResourceNode resourceNode)	Get the file name for a detail document
Optional<ResourceNode>	getDetailDocumentForField(Entity entity, String fieldModelName)
FolderNode	getEntityDocumentsFolder(Entity entity)	Get the entity's document folder
FolderNode	getEntityDocumentsFolder(Entity entity, String language)	Get the entity's document folder for the specified language.
FolderNode	getEntityModelFolder(EntityModel entityModel)	Get the entity documents folder for an entity model
FolderNode	getEntityModelFolder(String modelName)	Get the entity documents folder for an entity model
FolderNode	getOrCreateEntityDocumentsFolder(Entity entity)	Get or create an entity's document folder.
Optional<Entity>	getRelatedEntity(ContentTreeNode contentTreeNode)	Get the related entity associated with this ContentTreeNode
Optional<String>	getRelatedEntityRelationName(String relatedEntityName)
DomainNode	getSystemDomain()	Get the System Domain
boolean	isEntityDetailDocument(ResourceNode resourceNode)
boolean	isEntityDetailDocument(Entity resourceEntity)
boolean	isEntityDocument(ResourceNode resourceNode)
boolean	isEntityDocument(Entity resourceEntity)
boolean	isEntityDocumentFolder(FolderNode folderNode)	check if the folder is an entity doc folder (no matter if it's the root folder, the model root folder or a any child folder.
boolean	isEntityDocumentFolder(Entity entity)	check if the entity is an entity doc folder (no matter if it's the root folder, the model root folder or a any child folder.
boolean	isEntityModelFolder(Entity entity)	check if the entity is the root folder for an entity model
boolean	isEntityRootFolder(Entity entity)	check if the entity is the root folder for an entity
boolean	isRelationToRelatedEntity(String relationName)	Determine if a freely chosen relation is a relation from an entity document/folder to the related entity.
void	removeRelatedEntity(ContentTreeNode contentTreeNode)	Remove the related entity from the ContentTreeNode
void	setRelatedEntity(ContentTreeNode contentTreeNode, Entity entity)	Set a related entity for the ContentTreeNode

Methods inherited from class java.lang.Object

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

Constructor Details

EntityDocumentsServiceImpl

public EntityDocumentsServiceImpl(TypeManager typeManager,
 Context context,
 DataModel dataModel,
 QueryBuilderFactory queryBuilderFactory,
 ContentTreeService contentTreeService,
 CommandExecutor commandExecutor,
 TimezoneResolverService timezoneResolverService,
 SecurityManager securityManager,
 DefaultDisplayService defaultDisplayService,
 BusinessUnitManager businessUnitManager,
 org.slf4j.Logger log,
 L10N l10N)

Method Details

getSystemDomain

public DomainNode getSystemDomain()
                           throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the System Domain

Specified by:

getSystemDomain in interface EntityDocumentsService

Returns:

System Domain

Throws:

EntityDocumentsException

getEntityModelFolder

public FolderNode getEntityModelFolder(String modelName)
                                throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the entity documents folder for an entity model

Specified by:

getEntityModelFolder in interface EntityDocumentsService

Parameters:

modelName - name of the entity model

Returns:

entity documents folder

Throws:

EntityDocumentsException

getEntityModelFolder

public FolderNode getEntityModelFolder(EntityModel entityModel)
                                throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the entity documents folder for an entity model

Specified by:

getEntityModelFolder in interface EntityDocumentsService

Parameters:

entityModel - entity model

Returns:

entity documents folder

Throws:

EntityDocumentsException

getEntityDocumentsFolder

public FolderNode getEntityDocumentsFolder(Entity entity)
                                    throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the entity's document folder

     - [entity model folder]
      \- [entity folder]     <-- <b>folder returned</b>
        \- [language folder]
 

Specified by:

getEntityDocumentsFolder in interface EntityDocumentsService

Parameters:

entity - the entity

Returns:

entity's document folder

Throws:

EntityDocumentsException

getEntityDocumentsFolder

public FolderNode getEntityDocumentsFolder(Entity entity,
 String language)
                                    throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the entity's document folder for the specified language.

     - [entity model folder]
      \- [entity folder]
        \- [language folder] <-- <b>folder returned</b>
 

Specified by:

getEntityDocumentsFolder in interface EntityDocumentsService

Parameters:

entity - the entity

language - the language identifier

Returns:

entity's document folder for the specified language

Throws:

EntityDocumentsException

getRelatedEntityRelationName

public Optional<String> getRelatedEntityRelationName(String relatedEntityName)
                                              throws EntityDocumentsException

Specified by:

getRelatedEntityRelationName in interface EntityDocumentsService

Parameters:

relatedEntityName - name of a related entity model

Returns:

name of the relation to the required entity (if such a relation exists, Optional.empty() otherwise)

Throws:

EntityDocumentsException

isRelationToRelatedEntity

public boolean isRelationToRelatedEntity(String relationName)

Description copied from interface: EntityDocumentsService

Determine if a freely chosen relation is a relation from an entity document/folder to the related entity. I.e. if there exists an Entity called "Post", which also has entity docs: If this method is called with "relPost_entitydocs", true will be returned.

Specified by:

isRelationToRelatedEntity in interface EntityDocumentsService

Parameters:

relationName - Any relation name.

Returns:

true if it's a relation to the related entity, else false.

getRelatedEntity

public Optional<Entity> getRelatedEntity(ContentTreeNode contentTreeNode)
                                  throws EntityDocumentsException

Description copied from interface: EntityDocumentsService

Get the related entity associated with this ContentTreeNode

Specified by:

getRelatedEntity in interface EntityDocumentsService

Parameters:

contentTreeNode - ContentTreeNode

Returns:

an Optional containing the related entity (if available) or an Optional.empty() )

Throws:

EntityDocumentsException

isEntityRootFolder

public boolean isEntityRootFolder(Entity entity)
                           throws PersistException

Description copied from interface: EntityDocumentsService

check if the entity is the root folder for an entity

Specified by:

isEntityRootFolder in interface EntityDocumentsService

Parameters:

entity - the folder entity

Returns:

true / false

Throws:

PersistException

isEntityModelFolder

public boolean isEntityModelFolder(Entity entity)
                            throws PersistException

Description copied from interface: EntityDocumentsService

check if the entity is the root folder for an entity model

Specified by:

isEntityModelFolder in interface EntityDocumentsService

Parameters:

entity - the folder entity

Returns:

true / false

Throws:

PersistException

isEntityDocumentFolder

public boolean isEntityDocumentFolder(Entity entity)

Description copied from interface: EntityDocumentsService

check if the entity is an entity doc folder (no matter if it's the root folder, the model root folder or a any child folder.

Specified by:

isEntityDocumentFolder in interface EntityDocumentsService

Parameters:

entity - the folder entity

Returns:

true / false

isEntityDocumentFolder

public boolean isEntityDocumentFolder(FolderNode folderNode)

Description copied from interface: EntityDocumentsService

check if the folder is an entity doc folder (no matter if it's the root folder, the model root folder or a any child folder.

Specified by:

isEntityDocumentFolder in interface EntityDocumentsService

Parameters:

folderNode - the folder node

Returns:

true / false

addTimestampToFilename

public String addTimestampToFilename(String fileName)

Specified by:

addTimestampToFilename in interface EntityDocumentsService

isEntityDocument

public boolean isEntityDocument(Entity resourceEntity)
                         throws PersistException

Specified by:

isEntityDocument in interface EntityDocumentsService

Throws:

PersistException

isEntityDocument

public boolean isEntityDocument(ResourceNode resourceNode)
                         throws PersistException

Specified by:

isEntityDocument in interface EntityDocumentsService

Throws:

PersistException

isEntityDetailDocument

public boolean isEntityDetailDocument(Entity resourceEntity)
                               throws PersistException

Specified by:

isEntityDetailDocument in interface EntityDocumentsService

Throws:

PersistException

isEntityDetailDocument

public boolean isEntityDetailDocument(ResourceNode resourceNode)
                               throws PersistException

Specified by:

isEntityDetailDocument in interface EntityDocumentsService

Throws:

PersistException

getDetailDocumentFileName

public String getDetailDocumentFileName(ResourceNode resourceNode)
                                 throws PersistException

Description copied from interface: EntityDocumentsService

Get the file name for a detail document

Specified by:

getDetailDocumentFileName in interface EntityDocumentsService

Parameters:

resourceNode - a detail document ResourceNode (will throw an exception if any other ResourceNodes are provided.

Returns:

the file name for the detail document

Throws:

PersistException

getDetailDocumentForField

public Optional<ResourceNode> getDetailDocumentForField(Entity entity,
 String fieldModelName)

Specified by:

getDetailDocumentForField in interface EntityDocumentsService

setRelatedEntity

public void setRelatedEntity(ContentTreeNode contentTreeNode,
 Entity entity)
                      throws EntityDocumentsException

Description copied from interface: InternalEntityDocumentsService

Set a related entity for the ContentTreeNode

Specified by:

setRelatedEntity in interface InternalEntityDocumentsService

Parameters:

contentTreeNode - ContentTreeNode

entity - a reference entity (there needs to exist a relation rel[Entity model name] from the ContentTreeNode)

Throws:

EntityDocumentsException

removeRelatedEntity

public void removeRelatedEntity(ContentTreeNode contentTreeNode)
                         throws EntityDocumentsException

Description copied from interface: InternalEntityDocumentsService

Remove the related entity from the ContentTreeNode

Specified by:

removeRelatedEntity in interface InternalEntityDocumentsService

Parameters:

contentTreeNode - ContentTreeNode

Throws:

EntityDocumentsException

getOrCreateEntityDocumentsFolder

public FolderNode getOrCreateEntityDocumentsFolder(Entity entity)
                                            throws EntityDocumentsException

Description copied from interface: InternalEntityDocumentsService

Get or create an entity's document folder. It also creates potential required sub-folders (e.g. language folders for multi-language entities).

Specified by:

getOrCreateEntityDocumentsFolder in interface InternalEntityDocumentsService

Parameters:

entity - the entity

Returns:

entity's document folder

Throws:

EntityDocumentsException

createEntityDocumentsFolder

public FolderNode createEntityDocumentsFolder(Entity entity,
 FolderNode parentFolder)
                                       throws EntityDocumentsException

Description copied from interface: InternalEntityDocumentsService

Create an entity's document folder. It also creates potential required sub-folders (e.g. language folders for multi-language entities).

Specified by:

createEntityDocumentsFolder in interface InternalEntityDocumentsService

Parameters:

entity - the entity

parentFolder - the parent folder, i.e. the model's folder

Returns:

entity's document folder

Throws:

EntityDocumentsException

See Also:

• InternalEntityDocumentsService.getOrCreateEntityDocumentsFolder(Entity)

ensureLanguageFolders

public void ensureLanguageFolders(FolderNode parentFolder)
                           throws EntityDocumentsException

Description copied from interface: InternalEntityDocumentsService

make sure all language folders exist in the parent folder

Specified by:

ensureLanguageFolders in interface InternalEntityDocumentsService

Throws:

EntityDocumentsException

ensureEntityModelFolder

public FolderNode ensureEntityModelFolder(EntityModel entityModel)
                                   throws EntityDocumentsException

Specified by:

ensureEntityModelFolder in interface InternalEntityDocumentsService

Throws:

EntityDocumentsException

createEntityDocumentsInvoker

public Invoker createEntityDocumentsInvoker(List<EntityId> entities)

Specified by:

createEntityDocumentsInvoker in interface EntityDocumentsService