CMISAbstractDictionaryService (Alfresco Data Model API)

java.lang.Object
- org.springframework.extensions.surf.util.AbstractLifecycleBean
- - org.alfresco.opencmis.dictionary.CMISAbstractDictionaryService

All Implemented Interfaces:

java.util.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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CMISAbstractDictionaryService.DictionaryRegistry
CMIS Dictionary registry Index of CMIS Type Definitions

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 java.lang.String`	`ALFRESCO_EXTENSION_NAMESPACE`
`protected CMISMapping`	`cmisMapping`
`protected DictionaryService`	`dictionaryService`
`protected static org.apache.commons.logging.Log`	`logger`
`protected PropertyLuceneBuilderMapping`	`luceneBuilderMapping`
`static java.lang.String`	`MANDATORY_ASPECT`
`static java.lang.String`	`MANDATORY_ASPECTS`

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

Constructor Summary

Constructors
Constructor and Description

CMISAbstractDictionaryService()

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(java.lang.String propId)`
`PropertyDefinitionWrapper`	`findPropertyByQueryName(java.lang.String queryName)`
`TypeDefinitionWrapper`	`findType(java.lang.String typeId)` Find type for type id
`TypeDefinitionWrapper`	`findTypeByQueryName(java.lang.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)`
`java.util.List`	`getAllTypes()` Get all Types
`java.util.List`	`getBaseTypes()` Get Base Types
`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 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 java.lang.String ALFRESCO_EXTENSION_NAMESPACE
```
    See Also:
    Constant Field Values
  - MANDATORY_ASPECTS
```
public static final java.lang.String MANDATORY_ASPECTS
```
    See Also:
    Constant Field Values
  - MANDATORY_ASPECT
```
public static final java.lang.String MANDATORY_ASPECT
```
    See Also:
    Constant Field Values
  - dictionaryService
```
protected DictionaryService dictionaryService
```
  - cmisMapping
```
protected CMISMapping cmisMapping
```
  - accessorMapping
```
protected PropertyAccessorMapping accessorMapping
```
  - luceneBuilderMapping
```
protected PropertyLuceneBuilderMapping luceneBuilderMapping
```
- 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 singletonCache)
```
  - findType
```
public TypeDefinitionWrapper findType(java.lang.String typeId)
```
    Description copied from interface: CMISDictionaryService
    
    Find type for type id
    
    Specified by:
    
    findType in interface CMISDictionaryService
    
    Returns:
  - 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(java.lang.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(java.lang.String propId)
```
    Specified by:
    
    findProperty in interface CMISDictionaryService
  - findPropertyByQueryName
```
public PropertyDefinitionWrapper findPropertyByQueryName(java.lang.String queryName)
```
    Specified by:
    
    findPropertyByQueryName in interface CMISDictionaryService
  - getBaseTypes
```
public java.util.List getBaseTypes()
```
    Description copied from interface: CMISDictionaryService
    
    Get Base Types
    
    Specified by:
    
    getBaseTypes in interface CMISDictionaryService
  - getAllTypes
```
public java.util.List 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 -
  - 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

Class CMISAbstractDictionaryService

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

logger

ALFRESCO_EXTENSION_NAMESPACE

MANDATORY_ASPECTS

MANDATORY_ASPECT

dictionaryService

cmisMapping

accessorMapping

luceneBuilderMapping

Constructor Detail

CMISAbstractDictionaryService

Method Detail

setCmisMapping

setPropertyAccessorMapping

setPropertyLuceneBuilderMapping

setDictionaryService

setDictionaryDAO

setSingletonCache

findType

findTypeForClass

findNodeType

findAssocType

findTypeByQueryName

getAlfrescoClass

findProperty

findPropertyByQueryName

getBaseTypes

getAllTypes

findDataType

findAlfrescoDataType

createDefinitions

onDictionaryInit

afterDictionaryInit

afterDictionaryDestroy

onBootstrap

onShutdown