org.argeo.connect.resources.core

Class ResourcesServiceImpl

java.lang.Object

org.argeo.connect.core.AbstractAppService

org.argeo.connect.resources.core.ResourcesServiceImpl

All Implemented Interfaces:

AppService, ResourcesService

public class ResourcesServiceImpl
extends AbstractAppService
implements ResourcesService

Concrete access to people ResourcesService

Constructor Summary

Constructors

Constructor and Description
ResourcesServiceImpl()

Method Summary

Modifier and Type	Method and Description
boolean	canCreateTag(Session session)
long	countMembers(Node tag) Count members that have such a tag in the corresponding taggable sub tree
Node	createTagLikeResourceParent(Session session, java.lang.String tagId, java.lang.String tagInstanceType, java.lang.String codePropName, java.lang.String taggableParentPath, java.lang.String taggableNodeType, java.util.List<java.lang.String> taggablePropNames)
Node	createTagLikeResourceParent(Session session, java.lang.String tagId, java.lang.String tagInstanceType, java.lang.String codePropName, java.lang.String taggableParentPath, java.lang.String taggableNodeType, java.lang.String taggablePropName)
Node	createTemplateForType(Session session, java.lang.String nodeType, java.lang.String templateId)
java.lang.String	getAppBaseName() Returns the current App name
NodeIterator	getCatalogueValueInstances(Session session, java.lang.String entityType, java.lang.String propName, java.lang.String value) Retrieves all entities which property has the given value
java.lang.String	getDefaultRelPath(Node entity) Computes the App specific relative path for a known type based on properties of the passed node
java.lang.String	getDefaultRelPath(Session session, java.lang.String nodeType, java.lang.String id) Computes the App specific relative path for this known node type based on the passed id
java.lang.String	getEncodedTagCodeFromValue(Session session, java.lang.String tagId, java.lang.String value) Retrieves the code of an encoded tag given its English value or null if no such tag exists.
java.lang.String	getEncodedTagValue(Session session, java.lang.String tagId, java.lang.String code) Retrieves the value of an encoded tag or null if such a tag has not yet been registered
java.lang.String	getEncodedTagValuesAsString(java.lang.String tagId, Node node, java.lang.String propertyName, java.lang.String separator) Shortcut to retrieve a string that concatenates the corresponding values of a multi value property that refers to multiple encoded tags
java.lang.String	getItemDefaultEnLabel(java.lang.String itemId) Returns a canonical English label for each of the JCR Property or node types defined in the current People Repository.
java.lang.String	getItemLabel(java.lang.String itemName, java.lang.String langIso) Returns a label for each of the JCR property name or node type defined in the current People Repository in a internationalised context.
Node	getNodeTemplate(Session session, java.lang.String templateId)
Node	getRegisteredTag(Node tagParent, java.lang.String instanceKey) Retrieves the instance node given its value or code if it is an encodedTag or null if such a tag has not yet been registered Comparison is case insensitive and a trim() is applied on the passed String for not encoded tag
Node	getRegisteredTag(Session session, java.lang.String tagId, java.lang.String instanceKey) Retrieve the instance node given its value or code if it is an encodedTag or null if such a tag has not yet been registered Comparison is case insensitive and a trim() is applied on the passed String for not encoded tag
java.util.List<java.lang.String>	getRegisteredTagValueList(Session session, java.lang.String tagId, java.lang.String filter)
NodeIterator	getTaggedEntities(Node tagParent, java.lang.String key) Retrieves all entities that have this key
NodeIterator	getTaggedEntities(Session session, java.lang.String tagId, java.lang.String key) Retrieves all entities that have this tag key
protected java.lang.String	getTagKeyPropName(Node tagParent)
Node	getTagLikeResourceParent(Session session, java.lang.String tagId) Retrieves the parent for tag instances that correspond to this ID or null if non has been found
java.util.List<java.lang.String>	getTemplateCatalogue(Node node, java.lang.String propertyName, java.lang.String filter) Returns the predefined possible English values as defined in the passed template node and that match the corresponding filter.
java.util.List<java.lang.String>	getTemplateCatalogue(Session session, java.lang.String templateId, java.lang.String propertyName, java.lang.String filter) Returns the predefined possible English values of a property of a given node type as defined in the current People Repository and that match the corresponding filter.
boolean	isKnownType(Node entity) Simply checks if the passed entity has a primary or mixin type that is known and thus can be managed by the this App
boolean	isKnownType(java.lang.String nodeType) Simply checks if the passed type is known and thus can be managed by the this App.
Node	publishEntity(Node parent, java.lang.String nodeType, Node srcNode, boolean removeSrcNode)
void	refreshKnownTags(Node tagParent) Browses the repository using the parameters stored in the tagParent node and creates a new tag instance for all new value found in the taggable property of one of the valid node.
void	refreshKnownTags(Session session, java.lang.String tagId) Browses the repository using the parameters stored in the tagParent node and creates a new tag instance for all new value found in the taggable property of one of the valid node.
Node	registerTag(Session session, java.lang.String tagId, java.lang.String tagValue) Register a new tag if such a tag does not exist, does nothing otherwise.
Node	registerTag(Session session, java.lang.String tagId, java.lang.String tagCode, java.lang.String tagValue) Register a new tag if a tag with such a code does not yet exist, returns the existing one otherwise.
void	unregisterTag(Session session, java.lang.String tagId, java.lang.String tag) Unregister an existing tag and remove all references to this tag on all nodes under the tagableParentPath that have this tag
void	updateCatalogueValue(Node templateNode, java.lang.String taggableType, java.lang.String propertyName, java.lang.String oldValue, java.lang.String newValue) Change the value of a given template catalogue.
boolean	updateTag(Node tagInstance, java.lang.String newValue) Change the value of an already registered tag that does not rely on a code (e.g.

Methods inherited from class org.argeo.connect.core.AbstractAppService

createDraftEntity, getDisplayName, getDraftParent, getEntityByUid, saveEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.argeo.connect.AppService

createDraftEntity, getBaseRelPath, getDisplayName, getDraftParent, getEntityByUid, getLabel, getMainNodeType, publishEntity, saveEntity

Constructor Detail

ResourcesServiceImpl

public ResourcesServiceImpl()

Method Detail

publishEntity

public Node publishEntity(Node parent,
                          java.lang.String nodeType,
                          Node srcNode,
                          boolean removeSrcNode)
                   throws RepositoryException

Specified by:

publishEntity in interface AppService

Overrides:

publishEntity in class AbstractAppService

Throws:

RepositoryException

getAppBaseName

public java.lang.String getAppBaseName()

Description copied from interface: AppService

Returns the current App name

Specified by:

getAppBaseName in interface AppService

getDefaultRelPath

public java.lang.String getDefaultRelPath(Node entity)
                                   throws RepositoryException

Description copied from interface: AppService

Computes the App specific relative path for a known type based on properties of the passed node

Specified by:

getDefaultRelPath in interface AppService

Throws:

RepositoryException

getDefaultRelPath

public java.lang.String getDefaultRelPath(Session session,
                                          java.lang.String nodeType,
                                          java.lang.String id)

Description copied from interface: AppService

Computes the App specific relative path for this known node type based on the passed id

Specified by:

getDefaultRelPath in interface AppService

Parameters:

session - TODO

isKnownType

public boolean isKnownType(Node entity)

Description copied from interface: AppService

Simply checks if the passed entity has a primary or mixin type that is known and thus can be managed by the this App

Specified by:

isKnownType in interface AppService

isKnownType

public boolean isKnownType(java.lang.String nodeType)

Description copied from interface: AppService

Simply checks if the passed type is known and thus can be managed by the this App. It might be a primary or mixin type

Specified by:

isKnownType in interface AppService

getItemDefaultEnLabel

public java.lang.String getItemDefaultEnLabel(java.lang.String itemId)

Description copied from interface: ResourcesService

Returns a canonical English label for each of the JCR Property or node types defined in the current People Repository. If no such label is defined, returns the given itemName

Specified by:

getItemDefaultEnLabel in interface ResourcesService

getItemLabel

public java.lang.String getItemLabel(java.lang.String itemName,
                                     java.lang.String langIso)

Description copied from interface: ResourcesService

Returns a label for each of the JCR property name or node type defined in the current People Repository in a internationalised context. If the correct item label is not found for this language, the English label is returned. If such a label is not defined, it returns the item name.

Specified by:

getItemLabel in interface ResourcesService

getTemplateCatalogue

public java.util.List<java.lang.String> getTemplateCatalogue(Session session,
                                                             java.lang.String templateId,
                                                             java.lang.String propertyName,
                                                             java.lang.String filter)

Description copied from interface: ResourcesService

Returns the predefined possible English values of a property of a given node type as defined in the current People Repository and that match the corresponding filter. For the time being, a like "%value%" is assumed. It returns an empty list if the corresponding template is not found, if it has no property with such a name or if the filter does not match any of the predefined values.

Specified by:

getTemplateCatalogue in interface ResourcesService

templateId - generally, the corresponding NodeType

Returns:

a List of status

getTemplateCatalogue

public java.util.List<java.lang.String> getTemplateCatalogue(Node node,
                                                             java.lang.String propertyName,
                                                             java.lang.String filter)

Description copied from interface: ResourcesService

Returns the predefined possible English values as defined in the passed template node and that match the corresponding filter. For the time being, a like "%value%" is assumed. It returns an empty the template does not have a with such a name or if the filter does not match any of the predefined values.

Specified by:

getTemplateCatalogue in interface ResourcesService

Parameters:

node - the template, must not be null

Returns:

a List of status

getNodeTemplate

public Node getNodeTemplate(Session session,
                            java.lang.String templateId)

Specified by:

getNodeTemplate in interface ResourcesService

templateId - the template ID, it is by default the nodeType of the node for which this node is a template

Returns:

createTemplateForType

public Node createTemplateForType(Session session,
                                  java.lang.String nodeType,
                                  java.lang.String templateId)

Specified by:

createTemplateForType in interface ResourcesService

templateId - optional distinct id for this template

Returns:

getCatalogueValueInstances

public NodeIterator getCatalogueValueInstances(Session session,
                                               java.lang.String entityType,
                                               java.lang.String propName,
                                               java.lang.String value)

Description copied from interface: ResourcesService

Retrieves all entities which property has the given value

Specified by:

getCatalogueValueInstances in interface ResourcesService

Returns:

updateCatalogueValue

public void updateCatalogueValue(Node templateNode,
                                 java.lang.String taggableType,
                                 java.lang.String propertyName,
                                 java.lang.String oldValue,
                                 java.lang.String newValue)

Description copied from interface: ResourcesService

Change the value of a given template catalogue. It also updates this value in all business objects of the repository that have this value. If newValue is null it will only remove old value and unmark all entities TODO do this in a transaction and revert if the process is unsuccessful.

Specified by:

updateCatalogueValue in interface ResourcesService

createTagLikeResourceParent

public Node createTagLikeResourceParent(Session session,
                                        java.lang.String tagId,
                                        java.lang.String tagInstanceType,
                                        java.lang.String codePropName,
                                        java.lang.String taggableParentPath,
                                        java.lang.String taggableNodeType,
                                        java.lang.String taggablePropName)

Specified by:

createTagLikeResourceParent in interface ResourcesService

Parameters:

session - with write rights

tagId - An optional ID to differentiate distinct parent that might be similar

tagInstanceType - The node type of the corresponding resources. It defines the created parent if tagId is null

codePropName - The name of the property that provides the code in case the string we store in the taggable multi value property is not the label that has to be displayed

taggableParentPath - Absolute path to parent of the taggable nodes

taggableNodeType - Node type of the taggable nodes

taggablePropName - Name of the multi value property of the taggable node in which the corresponding tag is stored

Returns:

the newly created parent for tag instances

createTagLikeResourceParent

public Node createTagLikeResourceParent(Session session,
                                        java.lang.String tagId,
                                        java.lang.String tagInstanceType,
                                        java.lang.String codePropName,
                                        java.lang.String taggableParentPath,
                                        java.lang.String taggableNodeType,
                                        java.util.List<java.lang.String> taggablePropNames)

Specified by:

createTagLikeResourceParent in interface ResourcesService

Parameters:

session - with write rights

tagId - An optional ID to differentiate distinct parent that might be similar

tagInstanceType - The node type of the corresponding resources. It defines the created parent if tagId is null

codePropName - The name of the property that provides the code in case the string we store in the taggable multi value property is not the label that has to be displayed

taggableParentPath - Absolute path to parent of the taggable nodes

taggableNodeType - Node type of the taggable nodes

taggablePropNames - Names of the multi value property of the taggable node in which the corresponding tag is stored

Returns:

the newly created parent for tag instances

getTagLikeResourceParent

public Node getTagLikeResourceParent(Session session,
                                     java.lang.String tagId)

Description copied from interface: ResourcesService

Retrieves the parent for tag instances that correspond to this ID or null if non has been found

Specified by:

getTagLikeResourceParent in interface ResourcesService

Returns:

registerTag

public Node registerTag(Session session,
                        java.lang.String tagId,
                        java.lang.String tagValue)
                 throws RepositoryException

Description copied from interface: ResourcesService

Register a new tag if such a tag does not exist, does nothing otherwise. Corresponding session is not saved Comparison is case *insensitive* and a trim() is applied on the passed String

Specified by:

registerTag in interface ResourcesService

Returns:

Throws:

RepositoryException

registerTag

public Node registerTag(Session session,
                        java.lang.String tagId,
                        java.lang.String tagCode,
                        java.lang.String tagValue)
                 throws RepositoryException

Description copied from interface: ResourcesService

Register a new tag if a tag with such a code does not yet exist, returns the existing one otherwise. Corresponding session is not saved Comparison of the code is case *sensitive*. A trim() is applied on the passed tagValue before it is stored TODO also make a check if a tag already has such a value and prevent creation in this case. It is not blocker yet because we only use encode tags for country and languages that should not be manually updated

Specified by:

registerTag in interface ResourcesService

Returns:

Throws:

RepositoryException

getRegisteredTag

public Node getRegisteredTag(Session session,
                             java.lang.String tagId,
                             java.lang.String instanceKey)

Description copied from interface: ResourcesService

Retrieve the instance node given its value or code if it is an encodedTag or null if such a tag has not yet been registered Comparison is case insensitive and a trim() is applied on the passed String for not encoded tag

Specified by:

getRegisteredTag in interface ResourcesService

getRegisteredTag

public Node getRegisteredTag(Node tagParent,
                             java.lang.String instanceKey)

Description copied from interface: ResourcesService

Retrieves the instance node given its value or code if it is an encodedTag or null if such a tag has not yet been registered Comparison is case insensitive and a trim() is applied on the passed String for not encoded tag

Specified by:

getRegisteredTag in interface ResourcesService

getEncodedTagValue

public java.lang.String getEncodedTagValue(Session session,
                                           java.lang.String tagId,
                                           java.lang.String code)

Description copied from interface: ResourcesService

Retrieves the value of an encoded tag or null if such a tag has not yet been registered

Specified by:

getEncodedTagValue in interface ResourcesService

getEncodedTagCodeFromValue

public java.lang.String getEncodedTagCodeFromValue(Session session,
                                                   java.lang.String tagId,
                                                   java.lang.String value)

Description copied from interface: ResourcesService

Retrieves the code of an encoded tag given its English value or null if no such tag exists. WARNING: if two tags have the same value first found code will be returned see ResourcesService.registerTag(Session session, String tagId, String tagCode, String tagValue)

Specified by:

getEncodedTagCodeFromValue in interface ResourcesService

getEncodedTagValuesAsString

public java.lang.String getEncodedTagValuesAsString(java.lang.String tagId,
                                                    Node node,
                                                    java.lang.String propertyName,
                                                    java.lang.String separator)

Description copied from interface: ResourcesService

Shortcut to retrieve a string that concatenates the corresponding values of a multi value property that refers to multiple encoded tags

Specified by:

getEncodedTagValuesAsString in interface ResourcesService

Returns:

getTaggedEntities

public NodeIterator getTaggedEntities(Session session,
                                      java.lang.String tagId,
                                      java.lang.String key)

Description copied from interface: ResourcesService

Retrieves all entities that have this tag key

Specified by:

getTaggedEntities in interface ResourcesService

key - the code in case of an encoded tag, the value itself otherwise

Returns:

null if the corresponding tag parent is not found, and a node iterator (that might be empty) otherwise

getTaggedEntities

public NodeIterator getTaggedEntities(Node tagParent,
                                      java.lang.String key)

Description copied from interface: ResourcesService

Retrieves all entities that have this key

Specified by:

getTaggedEntities in interface ResourcesService

key - the code in case of an encoded tag, the value itself otherwise

refreshKnownTags

public void refreshKnownTags(Session session,
                             java.lang.String tagId)

Description copied from interface: ResourcesService

Browses the repository using the parameters stored in the tagParent node and creates a new tag instance for all new value found in the taggable property of one of the valid node. It is meant to update the tag referential after importing entity instances that are tagged. Please note that newly created encoded tags will be created by default with a label that is also the code. For the time being, this must be later manually fixed via the system UI.

Specified by:

refreshKnownTags in interface ResourcesService

refreshKnownTags

public void refreshKnownTags(Node tagParent)

Description copied from interface: ResourcesService

Browses the repository using the parameters stored in the tagParent node and creates a new tag instance for all new value found in the taggable property of one of the valid node. It is meant to update the tag referential after importing entity instances that are tagged. Please note that newly created encoded tags will be created by default with a label that is also the code. For the time being, this must be later manually fixed via the system UI.

Specified by:

refreshKnownTags in interface ResourcesService

updateTag

public boolean updateTag(Node tagInstance,
                         java.lang.String newValue)
                  throws RepositoryException

Description copied from interface: ResourcesService

Change the value of an already registered tag that does not rely on a code (e.g. the value that is stored in the various corresponding multi-value property). It also updates this value in all business objects of the repository that have this tag. TODO do this in a transaction and revert if the process is unsuccessful. TODO rather throw an exception than returning false

Specified by:

updateTag in interface ResourcesService

Throws:

RepositoryException

unregisterTag

public void unregisterTag(Session session,
                          java.lang.String tagId,
                          java.lang.String tag)

Description copied from interface: ResourcesService

Unregister an existing tag and remove all references to this tag on all nodes under the tagableParentPath that have this tag

Specified by:

unregisterTag in interface ResourcesService

countMembers

public long countMembers(Node tag)

Description copied from interface: ResourcesService

Count members that have such a tag in the corresponding taggable sub tree

Specified by:

countMembers in interface ResourcesService

getRegisteredTagValueList

public java.util.List<java.lang.String> getRegisteredTagValueList(Session session,
                                                                  java.lang.String tagId,
                                                                  java.lang.String filter)

Specified by:

getRegisteredTagValueList in interface ResourcesService

Returns:

the value of the known instances for this ID. Note that in the case of an encoded tag, the returned list contains values of the tags, not the codes but the filter applies on both (with a or)

getTagKeyPropName

protected java.lang.String getTagKeyPropName(Node tagParent)

canCreateTag

public boolean canCreateTag(Session session)

Specified by:

canCreateTag in interface ResourcesService