Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.dictionary
Interface DictionaryService
All Superinterfaces:
MessageLookup

@org.alfresco.api.AlfrescoPublicApi
public interface DictionaryService
extends MessageLookup
This interface represents the Repository Data Dictionary. The dictionary provides access to content meta-data such as Type and Aspect descriptions. Content meta-data is organised into models where each model is given a qualified name. This means that it is safe to develop independent models and bring them together into the same Repository without name clashes (as long their namespace is different).
Author:
David Caruana

Method Summary
getAllAspects()
getAllAspects(boolean includeInherited)
getAllAssociations()
          Get all the association definitions
getAllAssociations(boolean includeInherited)
getAllDataTypes()
getAllModels()
getAllProperties(QName dataType)
          Get all properties defined across all models with the given data type.
getAllTypes()
getAllTypes(boolean includeInherited)
getAnonymousType(QName name)
          Creates an anonymous TypeDefinition with all the mandatory Aspects applied.
getAnonymousType(QName type, Collection<QName> aspects)
          Construct an anonymous type that combines the definitions of the specified type and aspects.
getAspect(QName name)
getAspects(QName model)
getAssociation(QName associationName)
          Gets the definition of the association as defined by its owning Class.
getAssociations(QName model)
getClass(QName name)
getConstraint(QName constraintQName)
          Gets the definition of the constraint
getConstraints(QName model)
          Get constraints for the specified model
getConstraints(QName model, boolean referenceableDefsOnly)
          Get constraints for the specified model Optionally return referenceable (ie.
getDataType(Class<?> javaClass)
getDataType(QName name)
getDataTypes(QName model)
getModel(QName model)
getModelByNamespaceUri(String uri)
getProperties(QName model)
          Get all properties for the specified model
getProperties(QName model, QName dataType)
          Get all properties defined for the given model with the given data type.
getProperty(QName propertyName)
          Gets the definition of the property as defined by its owning Class.
getProperty(QName className, QName propertyName)
          Gets the definition of the property as defined by the specified Class.
getPropertyDefs(QName className)
          Gets the definitions of the properties defined by the specified Class.
getSubAspects(QName aspect, boolean follow)
getSubTypes(QName type, boolean follow)
          Get the sub types of the type.
getType(QName name)
getTypes(QName model)
boolean
isSubClass(QName className, QName ofClassName)
          Determines whether a class is a sub-class of another class
Methods inherited from interface org.alfresco.service.cmr.i18n.MessageLookup
getMessage, getMessage, getMessage, getMessage
Method Detail
getAllModels
@NotAuditable
Collection<QNamegetAllModels()
Returns:
the names of all models that have been registered with the Repository

getModel
@NotAuditable
ModelDefinition getModel(QName model)
Parameters:
model - the model name to retrieve
Returns:
the specified model (or null, if it doesn't exist)

getAllDataTypes
@NotAuditable
Collection<QNamegetAllDataTypes()
Returns:
the names of all data types that have been registered with the Repository

getDataTypes
@NotAuditable
Collection<QNamegetDataTypes(QName model)
Parameters:
model - the model to retrieve data types for
Returns:
the names of all data types defined within the specified model

getDataType
@NotAuditable
DataTypeDefinition getDataType(QName name)
Parameters:
name - the name of the data type to retrieve
Returns:
the data type definition (or null, if it doesn't exist)

getDataType
@NotAuditable
DataTypeDefinition getDataType(Class<?> javaClass)
Parameters:
javaClass - java class to find datatype for
Returns:
the data type definition (or null, if a mapping does not exist)

getAllTypes
@NotAuditable
Collection<QNamegetAllTypes()
Returns:
the names of all types that have been registered with the Repository

getAllTypes
@NotAuditable
Collection<QNamegetAllTypes(boolean includeInherited)

getSubTypes
@NotAuditable
Collection<QNamegetSubTypes(QName type,
                              boolean follow)
Get the sub types of the type. The returned list includes the base type which is passed in as a parameter.
Parameters:
type - the qualified name of the type
follow - true => all sub-type descendants, false => immediate sub-type children
Returns:
the names of the sub types of the specified type, including the value passed in.

getTypes
@NotAuditable
Collection<QNamegetTypes(QName model)
Parameters:
model - the model to retrieve types for
Returns:
the names of all types defined within the specified model

getType
@NotAuditable
TypeDefinition getType(QName name)
Parameters:
name - the name of the type to retrieve
Returns:
the type definition (or null, if it doesn't exist)

getAnonymousType
@NotAuditable
TypeDefinition getAnonymousType(QName type,
                                Collection<QName> aspects)
Construct an anonymous type that combines the definitions of the specified type and aspects.
Parameters:
type - the type to start with
aspects - the aspects to combine with the type
Returns:
the anonymous type definition

getAnonymousType
TypeDefinition getAnonymousType(QName name)
Creates an anonymous TypeDefinition with all the mandatory Aspects applied. This collapses all mandatory Aspects into a single TypeDefinition.
Parameters:
name - the name of the type definition.
Returns:
the anonymous type definition

getAllAspects
@NotAuditable
Collection<QNamegetAllAspects()
Returns:
the names of all aspects that have been registered with the Repository

getAllAspects
@NotAuditable
Collection<QNamegetAllAspects(boolean includeInherited)

getSubAspects
@NotAuditable
Collection<QNamegetSubAspects(QName aspect,
                                boolean follow)
Parameters:
aspect - QName
follow - true => follow up the super-class hierarchy, false => immediate sub aspects only
Returns:
the sub aspects of specified aspect

getAspects
@NotAuditable
Collection<QNamegetAspects(QName model)
Parameters:
model - the model to retrieve aspects for
Returns:
the names of all aspects defined within the specified model

getAssociations
@NotAuditable
Collection<QNamegetAssociations(QName model)
Parameters:
model - the model to retrieve associations for
Returns:
the names of all associations defined within the specified model

getAspect
@NotAuditable
AspectDefinition getAspect(QName name)
Parameters:
name - the name of the aspect to retrieve
Returns:
the aspect definition (or null, if it doesn't exist)

getClass
@NotAuditable
ClassDefinition getClass(QName name)
Parameters:
name - the name of the class (type or aspect) to retrieve
Returns:
the class definition (or null, if it doesn't exist)

isSubClass
@NotAuditable
boolean isSubClass(QName className,
                   QName ofClassName)
Determines whether a class is a sub-class of another class
Parameters:
className - the sub-class to test
ofClassName - the class to test against
Returns:
true => the class is a sub-class (or itself)

getProperty
@NotAuditable
PropertyDefinition getProperty(QName className,
                               QName propertyName)
Gets the definition of the property as defined by the specified Class. Note: A sub-class may override the definition of a property that's defined in a super-class.
Parameters:
className - the class name
propertyName - the property name
Returns:
the property definition (or null, if it doesn't exist)

getPropertyDefs
@NotAuditable
Map<QName,PropertyDefinitiongetPropertyDefs(QName className)
Gets the definitions of the properties defined by the specified Class.
Parameters:
className - the class name
Returns:
the property definitions

getProperty
@NotAuditable
PropertyDefinition getProperty(QName propertyName)
Gets the definition of the property as defined by its owning Class.
Parameters:
propertyName - the property name
Returns:
the property definition (or null, if it doesn't exist)

getAllProperties
@NotAuditable
Collection<QNamegetAllProperties(QName dataType)
Get all properties defined across all models with the given data type. Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties. If dataType is null then this method will return *ALL* properties regardless of data type.
Parameters:
dataType - QName
Returns:
Collection

getProperties
@NotAuditable
Collection<QNamegetProperties(QName model,
                                QName dataType)
Get all properties defined for the given model with the given data type. Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties. If dataType is null then this method will return *ALL* properties regardless of data type.
Parameters:
model - QName
dataType - QName
Returns:
Collection

getProperties
Collection<QNamegetProperties(QName model)
Get all properties for the specified model
Parameters:
model - QName
Returns:
Collection

getAssociation
@NotAuditable
AssociationDefinition getAssociation(QName associationName)
Gets the definition of the association as defined by its owning Class.
Parameters:
associationName - the property name
Returns:
the association definition (or null, if it doesn't exist)

getAllAssociations
@NotAuditable
Collection<QNamegetAllAssociations()
Get all the association definitions
Returns:
all the association qnames

getAllAssociations
@NotAuditable
Collection<QNamegetAllAssociations(boolean includeInherited)

getConstraint
@NotAuditable
ConstraintDefinition getConstraint(QName constraintQName)
Gets the definition of the constraint
Parameters:
constraintQName - the constraint name
Returns:
the constraint definition (or null, if it doesn't exist)
Since:
3.2.1

getConstraints
Collection<ConstraintDefinitiongetConstraints(QName model)
Get constraints for the specified model
Parameters:
model - QName
Returns:
Collection

getConstraints
Collection<ConstraintDefinitiongetConstraints(QName model,
                                                boolean referenceableDefsOnly)
Get constraints for the specified model Optionally return referenceable (ie. non-property specific) constraints only
Parameters:
model - QName
referenceableDefsOnly - boolean
Returns:
Collection
Since:
3.2R

getModelByNamespaceUri
ModelDefinition getModelByNamespaceUri(String uri)
Parameters:
uri - the namespace uri for search for
Returns:
the named model definition

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.