org.alfresco.opencmis.dictionary

Class CMISAbstractDictionaryService

java.lang.Object

org.springframework.extensions.surf.util.AbstractLifecycleBean

org.alfresco.opencmis.dictionary.CMISAbstractDictionaryService

All Implemented Interfaces:

EventListener, CMISDictionaryService, DictionaryListener, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

Direct Known Subclasses:

CMISStrictDictionaryService

public abstract class CMISAbstractDictionaryService
extends org.springframework.extensions.surf.util.AbstractLifecycleBean
implements CMISDictionaryService, DictionaryListener

Common CMIS Dictionary Support including registry of Types.

Author:

davidc, florian.mueller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CMISAbstractDictionaryService.DictionaryRegistry CMIS Dictionary registry Index of CMIS Type Definitions

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyAccessorMapping	accessorMapping
static String	ALFRESCO_EXTENSION_NAMESPACE
protected CMISMapping	cmisMapping
protected DictionaryService	dictionaryService
protected String	key_opencmis_dictionary_registry
protected static org.apache.commons.logging.Log	logger
protected PropertyLuceneBuilderMapping	luceneBuilderMapping
static String	MANDATORY_ASPECT
static String	MANDATORY_ASPECTS

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

log

Constructor Summary

Constructors

Constructor and Description
CMISAbstractDictionaryService()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterDictionaryDestroy()
void	afterDictionaryInit()
protected abstract void	createDefinitions(CMISAbstractDictionaryService.DictionaryRegistry registry) Factory for creating CMIS Definitions
QName	findAlfrescoDataType(org.apache.chemistry.opencmis.commons.enums.PropertyType propertyType)
TypeDefinitionWrapper	findAssocType(QName clazz)
org.apache.chemistry.opencmis.commons.enums.PropertyType	findDataType(QName dataType) Find data type
TypeDefinitionWrapper	findNodeType(QName clazz)
PropertyDefinitionWrapper	findProperty(String propId)
PropertyDefinitionWrapper	findPropertyByQueryName(String queryName)
TypeDefinitionWrapper	findType(String typeId) Find type for type id
TypeDefinitionWrapper	findTypeByQueryName(String queryName) Find a type by its query name
TypeDefinitionWrapper	findTypeForClass(QName clazz, org.apache.chemistry.opencmis.commons.enums.BaseTypeId... matchingScopes) Find type for Alfresco class name.
QName	getAlfrescoClass(QName name)
List<TypeDefinitionWrapper>	getAllTypes() Get all Types
List<TypeDefinitionWrapper>	getBaseTypes() Get Base Types
String	getCmisTypeId(QName classQName)
protected CMISAbstractDictionaryService.DictionaryRegistry	getRegistry()
protected CMISAbstractDictionaryService.DictionaryRegistry	getRegistryImpl()
protected void	init() Dictionary Initialization - creates a new registry
boolean	isExcluded(QName qname)
protected void	onBootstrap(org.springframework.context.ApplicationEvent event)
void	onDictionaryInit()
protected void	onShutdown(org.springframework.context.ApplicationEvent event)
void	setCmisMapping(CMISMapping cmisMapping) Set the mapping service
void	setDictionaryDAO(DictionaryDAO dictionaryDAO) Set the dictionary DAO
void	setDictionaryService(DictionaryService dictionaryService) Set the dictionary Service
void	setPropertyAccessorMapping(PropertyAccessorMapping accessorMapping) Set the property accessor mapping service
void	setPropertyLuceneBuilderMapping(PropertyLuceneBuilderMapping luceneBuilderMapping) Set the property lucene mapping service
void	setSingletonCache(SimpleCache<String,CMISAbstractDictionaryService.DictionaryRegistry> singletonCache)

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

getApplicationContext, onApplicationEvent, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

ALFRESCO_EXTENSION_NAMESPACE

public static final String ALFRESCO_EXTENSION_NAMESPACE

See Also:

Constant Field Values

MANDATORY_ASPECTS

public static final String MANDATORY_ASPECTS

See Also:

Constant Field Values

MANDATORY_ASPECT

public static final String MANDATORY_ASPECT

See Also:

Constant Field Values

dictionaryService

protected DictionaryService dictionaryService

cmisMapping

protected CMISMapping cmisMapping

accessorMapping

protected PropertyAccessorMapping accessorMapping

luceneBuilderMapping

protected PropertyLuceneBuilderMapping luceneBuilderMapping

key_opencmis_dictionary_registry

protected String key_opencmis_dictionary_registry

Constructor Detail

CMISAbstractDictionaryService

public CMISAbstractDictionaryService()

Method Detail

setCmisMapping

public void setCmisMapping(CMISMapping cmisMapping)

Set the mapping service

Parameters:

cmisMapping -

setPropertyAccessorMapping

public void setPropertyAccessorMapping(PropertyAccessorMapping accessorMapping)

Set the property accessor mapping service

Parameters:

accessor - mapping

setPropertyLuceneBuilderMapping

public void setPropertyLuceneBuilderMapping(PropertyLuceneBuilderMapping luceneBuilderMapping)

Set the property lucene mapping service

Parameters:

lucene - mapping

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

Set the dictionary Service

Parameters:

dictionaryService -

setDictionaryDAO

public void setDictionaryDAO(DictionaryDAO dictionaryDAO)

Set the dictionary DAO

Parameters:

dictionaryDAO -

setSingletonCache

public void setSingletonCache(SimpleCache<String,CMISAbstractDictionaryService.DictionaryRegistry> singletonCache)

getRegistry

protected CMISAbstractDictionaryService.DictionaryRegistry getRegistry()

getRegistryImpl

protected CMISAbstractDictionaryService.DictionaryRegistry getRegistryImpl()

findType

public TypeDefinitionWrapper findType(String typeId)

Description copied from interface: CMISDictionaryService

Find type for type id

Specified by:

findType in interface CMISDictionaryService

Returns:

isExcluded

public boolean isExcluded(QName qname)

Specified by:

isExcluded in interface CMISDictionaryService

findTypeForClass

public TypeDefinitionWrapper findTypeForClass(QName clazz,
                                     org.apache.chemistry.opencmis.commons.enums.BaseTypeId... matchingScopes)

Description copied from interface: CMISDictionaryService

Find type for Alfresco class name. Optionally, constrain match to one of specified CMIS scopes

Specified by:

findTypeForClass in interface CMISDictionaryService

Returns:

findNodeType

public TypeDefinitionWrapper findNodeType(QName clazz)

Specified by:

findNodeType in interface CMISDictionaryService

findAssocType

public TypeDefinitionWrapper findAssocType(QName clazz)

Specified by:

findAssocType in interface CMISDictionaryService

findTypeByQueryName

public TypeDefinitionWrapper findTypeByQueryName(String queryName)

Description copied from interface: CMISDictionaryService

Find a type by its query name

Specified by:

findTypeByQueryName in interface CMISDictionaryService

Returns:

getAlfrescoClass

public QName getAlfrescoClass(QName name)

findProperty

public PropertyDefinitionWrapper findProperty(String propId)

Specified by:

findProperty in interface CMISDictionaryService

findPropertyByQueryName

public PropertyDefinitionWrapper findPropertyByQueryName(String queryName)

Specified by:

findPropertyByQueryName in interface CMISDictionaryService

getBaseTypes

public List<TypeDefinitionWrapper> getBaseTypes()

Description copied from interface: CMISDictionaryService

Get Base Types

Specified by:

getBaseTypes in interface CMISDictionaryService

getAllTypes

public List<TypeDefinitionWrapper> getAllTypes()

Description copied from interface: CMISDictionaryService

Get all Types

Specified by:

getAllTypes in interface CMISDictionaryService

Returns:

findDataType

public org.apache.chemistry.opencmis.commons.enums.PropertyType findDataType(QName dataType)

Description copied from interface: CMISDictionaryService

Find data type

Specified by:

findDataType in interface CMISDictionaryService

Returns:

findAlfrescoDataType

public QName findAlfrescoDataType(org.apache.chemistry.opencmis.commons.enums.PropertyType propertyType)

Specified by:

findAlfrescoDataType in interface CMISDictionaryService

createDefinitions

protected abstract void createDefinitions(CMISAbstractDictionaryService.DictionaryRegistry registry)

Factory for creating CMIS Definitions

Parameters:

registry -

init

protected void init()

Dictionary Initialization - creates a new registry

onDictionaryInit

public void onDictionaryInit()

Specified by:

onDictionaryInit in interface DictionaryListener

afterDictionaryInit

public void afterDictionaryInit()

Specified by:

afterDictionaryInit in interface DictionaryListener

afterDictionaryDestroy

public void afterDictionaryDestroy()

Specified by:

afterDictionaryDestroy in interface DictionaryListener

onBootstrap

protected void onBootstrap(org.springframework.context.ApplicationEvent event)

Specified by:

onBootstrap in class org.springframework.extensions.surf.util.AbstractLifecycleBean

onShutdown

protected void onShutdown(org.springframework.context.ApplicationEvent event)

Specified by:

onShutdown in class org.springframework.extensions.surf.util.AbstractLifecycleBean

getCmisTypeId

public String getCmisTypeId(QName classQName)