org.alfresco.web.scripts

Class DictionaryQuery

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessorExtension

org.alfresco.web.scripts.SingletonValueProcessorExtension<org.alfresco.web.scripts.Dictionary>

org.alfresco.web.scripts.DictionaryQuery

All Implemented Interfaces:

Serializable, org.springframework.extensions.surf.core.processor.ProcessorExtension

public class DictionaryQuery
extends SingletonValueProcessorExtension<org.alfresco.web.scripts.Dictionary>
implements Serializable

Slingleton scripting host object provided to allows scripts to execute basic Alfresco Data Dictionary model queries.

Service object that maintains no state other than the dictionary itself.

Queries include: isSubType, isAspect, hasProperty, getParentType etc.

Author:

Kevin Roast

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DictionaryQuery()

Method Summary

Methods

Modifier and Type	Method and Description
Dictionary.DictionaryAssoc[]	getAssociations(String ddclass) getAssociations - return the target associations for the given dd class.
Dictionary.DictionaryAssoc[]	getChildAssociations(String ddclass) getChildAssociations - return the child associations for the given dd class.
String[]	getDefaultAspects(String type) getDefaultAspects - return Array of default aspects for the given type.
String	getDescription(String ddclass) getDescription - return the description string for the given dd class.
String	getParent(String ddclass) getParent - return the parent for the given dd class.
Dictionary.DictionaryProperty[]	getProperties(String ddclass) getProperties - return all properties for the given dd class.
Dictionary.DictionaryProperty[]	getProperties(String ddclass, boolean includeDefaultAspects) getProperties - return all properties for the given dd class.
Dictionary.DictionaryProperty	getProperty(String ddclass, String property) getProperty - return a single named property for the given dd class.
Dictionary.DictionaryProperty	getProperty(String ddclass, String property, boolean includeDefaultAspects) getProperty - return a single named property for the given dd class, optionally retrieve a property from the default aspects.
String	getTitle(String ddclass) getTitle - return the title string for the given dd class.
protected String	getValueName() Output value name for informational and error messages to the administrator.
boolean	hasDefaultAspect(String type, String aspect) hasDefaultAspect - return if the type definition has the default aspect applied..
boolean	hasProperty(String ddclass, String property) hasProperty - return if a type or aspect has the given property definition.
boolean	hasProperty(String ddclass, String property, boolean includeDefaultAspects) hasProperty - return if a type or aspect has the given property definition.
boolean	isAspect(String ddclass) isAspect - return if the supplied dd class is an aspect.
boolean	isContainer(String type) isContainer - return if the specified type is a container
boolean	isSubType(String type, String isType) isSubType - return if the supplied type is a sub-type of a given type.
protected boolean	isTenant()
boolean	isType(String ddclass) isType - return if the supplied dd class is a type.
protected org.alfresco.web.scripts.Dictionary	retrieveValue(String userId, String storeId) Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API.
String	toString()

Methods inherited from class org.alfresco.web.scripts.SingletonValueProcessorExtension

getSingletonValue, getSingletonValue

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessors

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryQuery

public DictionaryQuery()

Method Detail

isSubType

public boolean isSubType(String type,
                String isType)

isSubType - return if the supplied type is a sub-type of a given type.

Parameters:

type - Type to test

isType - Is the type a subtype of this type?

Returns:

true if the type is a subtype of isType or the same type

hasDefaultAspect

public boolean hasDefaultAspect(String type,
                       String aspect)

hasDefaultAspect - return if the type definition has the default aspect applied..

Parameters:

type - Type to test

aspect - Aspect to look for in the default aspects

Returns:

true if the aspect is one of the default aspects

getDefaultAspects

public String[] getDefaultAspects(String type)

getDefaultAspects - return Array of default aspects for the given type.

Parameters:

type - Type to inspect

Returns:

Array of default aspects for the type, can be empty but never null.

isAspect

public boolean isAspect(String ddclass)

isAspect - return if the supplied dd class is an aspect.

Parameters:

ddclass - DD class to test

Returns:

true if the supplied dd class is an aspect

isType

public boolean isType(String ddclass)

isType - return if the supplied dd class is a type.

Parameters:

ddclass - DD class to test

Returns:

true if the supplied dd class is a type

hasProperty

public boolean hasProperty(String ddclass,
                  String property)

hasProperty - return if a type or aspect has the given property definition. This method correctly reports properties inherited from base types.

Parameters:

ddclass - Type or aspect to test

property - Property to look for in the type or aspect definition

Returns:

true if the property is defined on the type or aspect

hasProperty

public boolean hasProperty(String ddclass,
                  String property,
                  boolean includeDefaultAspects)

hasProperty - return if a type or aspect has the given property definition. This method correctly reports properties inherited from base types and also optionally checks any default aspects applied to the type for the property.

Parameters:

ddclass - Type or aspect to test

property - Property to look for in the type or aspect definition

includeDefaultAspects - If true, check default aspects for the given property.

Returns:

true if the property is defined on the type or aspect or any of its default aspects.

getTitle

public String getTitle(String ddclass)

getTitle - return the title string for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

title string

getDescription

public String getDescription(String ddclass)

getDescription - return the description string for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

description string

getParent

public String getParent(String ddclass)

getParent - return the parent for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

parent type or null for a root type with no parent.

isContainer

public boolean isContainer(String type)

isContainer - return if the specified type is a container

Parameters:

type - Type to inspect

Returns:

true if the type is a container, false otherwise

getProperty

public Dictionary.DictionaryProperty getProperty(String ddclass,
                                        String property)

getProperty - return a single named property for the given dd class.

Parameters:

ddclass - DD class to inspect

property - Property to look for in the type or aspect definition

Returns:

DictionaryProperty describing the property definition or null if not found

getProperty

public Dictionary.DictionaryProperty getProperty(String ddclass,
                                        String property,
                                        boolean includeDefaultAspects)

getProperty - return a single named property for the given dd class, optionally retrieve a property from the default aspects.

Parameters:

ddclass - DD class to inspect

property - Property to look for in the type or aspect definition

includeDefaultAspects - If true, check default aspects for the given property.

Returns:

DictionaryProperty describing the property definition or null if not found

getProperties

public Dictionary.DictionaryProperty[] getProperties(String ddclass)

getProperties - return all properties for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

Array of DictionaryProperty objects describing the property definitions for the class. Can be empty but never null.

getProperties

public Dictionary.DictionaryProperty[] getProperties(String ddclass,
                                            boolean includeDefaultAspects)

getProperties - return all properties for the given dd class.

Parameters:

ddclass - DD class to inspect

includeDefaultAspects - If true, also retrieve properties from the default aspects.

Returns:

Array of DictionaryProperty objects describing the property definitions for the class and default aspects. Can be empty but never null.

getAssociations

public Dictionary.DictionaryAssoc[] getAssociations(String ddclass)

getAssociations - return the target associations for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

Array of DictionaryAssoc objects describing the target associations for the class. Can be empty but never null.

getChildAssociations

public Dictionary.DictionaryAssoc[] getChildAssociations(String ddclass)

getChildAssociations - return the child associations for the given dd class.

Parameters:

ddclass - DD class to inspect

Returns:

Array of DictionaryAssoc objects describing the child associations for the class. Can be empty but never null.

toString

public String toString()

Overrides:

toString in class Object

isTenant

protected boolean isTenant()

Returns:

true for tenant specific Dictionary support, false to share a single Dictionary.

retrieveValue

protected org.alfresco.web.scripts.Dictionary retrieveValue(String userId,
                                                String storeId)
                                                     throws org.springframework.extensions.surf.exception.ConnectorServiceException

Description copied from class: SingletonValueProcessorExtension

Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API. This is generally used to execute a REST API and extract a value from a response. The value is then automatically stored by the base class.

Specified by:

retrieveValue in class SingletonValueProcessorExtension<org.alfresco.web.scripts.Dictionary>

Parameters:

userId - Current user Id

storeId - Current store Id if any - may be used if per-tenant values are required

Returns:

value from the remote endpoint

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException

getValueName

protected String getValueName()

Description copied from class: SingletonValueProcessorExtension

Output value name for informational and error messages to the administrator.

Specified by:

getValueName in class SingletonValueProcessorExtension<org.alfresco.web.scripts.Dictionary>

Returns:

output value name