org.nuxeo.ecm.core.schema

Class SchemaManagerImpl

java.lang.Object

org.nuxeo.ecm.core.schema.SchemaManagerImpl

All Implemented Interfaces:

SchemaManager, TypeProvider

public class SchemaManagerImpl
extends Object
implements SchemaManager

Schema Manager implementation.

Holds basic types (String, Integer, etc.), schemas, document types and facets.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TypeConfiguration>	allConfigurations All the registered configurations (prefetch).
protected List<DocumentTypeDescriptor>	allDocumentTypes All the registered document types.
protected List<FacetDescriptor>	allFacets All the registered facets.
protected boolean	allowVersionWriteForDublinCore Effective allowVersionWriteForDublinCore flag.
protected List<ProxiesDescriptor>	allProxies All the registered proxy descriptors.
protected List<SchemaBindingDescriptor>	allSchemas All the registered schemas.
static boolean	CLEAR_COMPLEX_PROP_BEFORE_SET_DEFAULT Default used for clearComplexPropertyBeforeSet if there is no XML configuration found.
protected boolean	clearComplexPropertyBeforeSet Effective clearComplexPropertyBeforeSet flag.
protected Map<String,Map<String,String>>	deprecatedProperties
protected boolean	dirty Whether there have been changes to the registered schemas, facets or document types that require recomputation of the effective ones.
protected Map<String,DocumentTypeImpl>	documentTypes Effective document types.
protected Map<String,Set<String>>	documentTypesExtending
protected Map<String,Set<String>>	documentTypesForFacet
protected Map<String,CompositeType>	facets Effective facets.
protected Set<String>	noPerDocumentQueryFacets
protected PrefetchInfo	prefetchInfo Effective prefetch info.
protected Map<String,Schema>	prefixToSchema
protected Set<String>	proxySchemaNames Effective proxy schema names.
protected List<Schema>	proxySchemas Effective proxy schemas.
protected List<Runnable>	recomputeCallbacks
protected Map<String,Map<String,String>>	removedProperties
protected Map<String,Schema>	schemas Effective schemas.
static String	SCHEMAS_DIR_NAME
protected Map<String,Type>	types Basic type registry.
protected Map<String,Schema>	uriToSchema

Constructor Summary

Constructors

Constructor and Description
SchemaManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	checkDirty() Checks if something has to be recomputed if a dynamic register/unregister happened.
protected void	clearSchemaDir()
protected void	copySchema(SchemaBindingDescriptor sd)
protected void	executeRecomputeCallbacks()
void	flushPendingsRegistration()
Set<String>	getAllowedSubTypes(String typeName) Returns the types of the children that can be created inside a given type type.
boolean	getAllowVersionWriteForDublinCore() Whether we allow to write the dublincore schema on a version.
boolean	getClearComplexPropertyBeforeSet() Whether or not to ignore any previous values when setting complex properties.
PropertyDeprecationHandler	getDeprecatedProperties()
DocumentType	getDocumentType(String name) Gets a document type.
DocumentTypeDescriptor	getDocumentTypeDescriptor(String name)
Set<String>	getDocumentTypeNamesExtending(String docTypeName) Return the names of all document types extending the given one, which is included.
Set<String>	getDocumentTypeNamesForFacet(String facet) Returns the names of all document types that have given facet.
DocumentType[]	getDocumentTypes() Gets the list of document types.
int	getDocumentTypesCount()
CompositeType	getFacet(String name) Gets a facet.
FacetDescriptor	getFacetDescriptor(String name)
CompositeType[]	getFacets() Gets the list of facets.
Field	getField(Field parent, String subFieldName) Returns the field with given parent field and sub name, or null if not found.
protected Field	getField(Field parent, String subFieldName, boolean finalCall)
Field	getField(String xpath) Returns the field with given xpath, or null if not found.
Set<String>	getNoPerDocumentQueryFacets() Finds which facets are configured as no-per-instance-query.
List<Schema>	getProxySchemas(String docType) Gets the schemas on a proxy for a document of the given type.
PropertyDeprecationHandler	getRemovedProperties()
Schema	getSchema(String name) Gets a schema.
Schema	getSchemaFromPrefix(String schemaPrefix)
Schema	getSchemaFromURI(String schemaURI)
Schema[]	getSchemas() Gets the list of schemas.
File	getSchemasDir()
protected Type	getType(String name)
protected Collection<Type>	getTypes()
boolean	hasSuperType(String docType, String superType) Returns true if docType is or extends superType, false otherwise.
boolean	isProxySchema(String schema, String docType) Checks if a schema is on a proxy for a document of the given type.
protected void	loadSchema(SchemaBindingDescriptor sd)
protected DocumentTypeDescriptor	mergeDocumentTypeDescriptors(DocumentTypeDescriptor src, DocumentTypeDescriptor dst)
protected void	recompute() Recomputes effective registries for schemas, facets and document types.
protected void	recomputeConfiguration()
protected DocumentType	recomputeDocumentType(String name, DocumentTypeDescriptor dtd, DocumentType parent)
protected DocumentType	recomputeDocumentType(String name, Set<String> stack, Map<String,DocumentTypeDescriptor> dtds)
protected void	recomputeDocumentTypes()
void	recomputeDynamicFacets()
protected void	recomputeFacet(FacetDescriptor fd)
protected void	recomputeFacets()
protected void	recomputeProxies()
protected void	recomputeSchemas()
protected void	registerBuiltinTypes()
void	registerConfiguration(TypeConfiguration config)
void	registerDocumentType(DocumentTypeDescriptor dtd)
protected void	registerDocumentType(DocumentTypeImpl docType)
void	registerFacet(FacetDescriptor fd)
protected CompositeType	registerFacet(String name, Set<String> schemaNames)
void	registerPropertyDeprecation(PropertyDeprecationDescriptor descriptor)
void	registerProxies(ProxiesDescriptor pd)
void	registerRecomputeCallback(Runnable callback)
protected void	registerSchema(Schema schema)
void	registerSchema(SchemaBindingDescriptor sd)
protected void	registerType(Type type)
protected Field	resolveSubField(ListType listType, String subName, boolean fallbackOnSubElement)
void	unregisterConfiguration(TypeConfiguration config)
void	unregisterDocumentType(DocumentTypeDescriptor dtd)
void	unregisterFacet(FacetDescriptor fd)
void	unregisterPropertyDeprecation(PropertyDeprecationDescriptor descriptor)
void	unregisterProxies(ProxiesDescriptor pd)
void	unregisterRecomputeCallback(Runnable callback)
void	unregisterSchema(SchemaBindingDescriptor sd)

Methods inherited from class java.lang.Object

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

Field Detail

dirty

protected volatile boolean dirty

Whether there have been changes to the registered schemas, facets or document types that require recomputation of the effective ones.

types

protected Map<String,Type> types

Basic type registry.

allConfigurations

protected List<TypeConfiguration> allConfigurations

All the registered configurations (prefetch).

allSchemas

protected List<SchemaBindingDescriptor> allSchemas

All the registered schemas.

allFacets

protected List<FacetDescriptor> allFacets

All the registered facets.

allDocumentTypes

protected List<DocumentTypeDescriptor> allDocumentTypes

All the registered document types.

allProxies

protected List<ProxiesDescriptor> allProxies

All the registered proxy descriptors.

prefetchInfo

protected PrefetchInfo prefetchInfo

Effective prefetch info.

clearComplexPropertyBeforeSet

protected boolean clearComplexPropertyBeforeSet

Effective clearComplexPropertyBeforeSet flag.

allowVersionWriteForDublinCore

protected boolean allowVersionWriteForDublinCore

Effective allowVersionWriteForDublinCore flag.

schemas

protected Map<String,Schema> schemas

Effective schemas.

uriToSchema

protected final Map<String,Schema> uriToSchema

prefixToSchema

protected final Map<String,Schema> prefixToSchema

facets

protected Map<String,CompositeType> facets

Effective facets.

noPerDocumentQueryFacets

protected Set<String> noPerDocumentQueryFacets

documentTypes

protected Map<String,DocumentTypeImpl> documentTypes

Effective document types.

documentTypesExtending

protected Map<String,Set<String>> documentTypesExtending

documentTypesForFacet

protected Map<String,Set<String>> documentTypesForFacet

proxySchemas

protected List<Schema> proxySchemas

Effective proxy schemas.

proxySchemaNames

protected Set<String> proxySchemaNames

Effective proxy schema names.

SCHEMAS_DIR_NAME

public static final String SCHEMAS_DIR_NAME

See Also:

Constant Field Values

CLEAR_COMPLEX_PROP_BEFORE_SET_DEFAULT

public static final boolean CLEAR_COMPLEX_PROP_BEFORE_SET_DEFAULT

Default used for clearComplexPropertyBeforeSet if there is no XML configuration found.

Since:

9.3

See Also:

Constant Field Values

recomputeCallbacks

protected List<Runnable> recomputeCallbacks

deprecatedProperties

protected Map<String,Map<String,String>> deprecatedProperties

Since:

9.2

removedProperties

protected Map<String,Map<String,String>> removedProperties

Since:

9.2

Constructor Detail

SchemaManagerImpl

public SchemaManagerImpl()

Method Detail

clearSchemaDir

protected void clearSchemaDir()

getSchemasDir

public File getSchemasDir()

registerBuiltinTypes

protected void registerBuiltinTypes()

registerType

protected void registerType(Type type)

getType

protected Type getType(String name)

getTypes

protected Collection<Type> getTypes()

registerConfiguration

public void registerConfiguration(TypeConfiguration config)

unregisterConfiguration

public void unregisterConfiguration(TypeConfiguration config)

registerSchema

public void registerSchema(SchemaBindingDescriptor sd)

unregisterSchema

public void unregisterSchema(SchemaBindingDescriptor sd)

registerFacet

public void registerFacet(FacetDescriptor fd)

unregisterFacet

public void unregisterFacet(FacetDescriptor fd)

registerDocumentType

public void registerDocumentType(DocumentTypeDescriptor dtd)

unregisterDocumentType

public void unregisterDocumentType(DocumentTypeDescriptor dtd)

getDocumentTypeDescriptor

public DocumentTypeDescriptor getDocumentTypeDescriptor(String name)

getFacetDescriptor

public FacetDescriptor getFacetDescriptor(String name)

recomputeDynamicFacets

public void recomputeDynamicFacets()

registerProxies

public void registerProxies(ProxiesDescriptor pd)

unregisterProxies

public void unregisterProxies(ProxiesDescriptor pd)

checkDirty

public void checkDirty()

Checks if something has to be recomputed if a dynamic register/unregister happened.

recompute

protected void recompute()

Recomputes effective registries for schemas, facets and document types.

recomputeConfiguration

protected void recomputeConfiguration()

recomputeSchemas

protected void recomputeSchemas()

copySchema

protected void copySchema(SchemaBindingDescriptor sd)
                   throws IOException

Throws:

IOException

loadSchema

protected void loadSchema(SchemaBindingDescriptor sd)
                   throws IOException,
                          SAXException,
                          TypeException

Throws:

IOException

SAXException

TypeException

registerSchema

protected void registerSchema(Schema schema)

getSchemas

public Schema[] getSchemas()

Description copied from interface: TypeProvider

Gets the list of schemas.

Specified by:

getSchemas in interface TypeProvider

getSchema

public Schema getSchema(String name)

Description copied from interface: TypeProvider

Gets a schema.

Specified by:

getSchema in interface TypeProvider

getSchemaFromPrefix

public Schema getSchemaFromPrefix(String schemaPrefix)

Specified by:

getSchemaFromPrefix in interface SchemaManager

getSchemaFromURI

public Schema getSchemaFromURI(String schemaURI)

Specified by:

getSchemaFromURI in interface SchemaManager

recomputeFacets

protected void recomputeFacets()

recomputeFacet

protected void recomputeFacet(FacetDescriptor fd)

registerFacet

protected CompositeType registerFacet(String name,
                                      Set<String> schemaNames)

getFacets

public CompositeType[] getFacets()

Description copied from interface: TypeProvider

Gets the list of facets.

Specified by:

getFacets in interface TypeProvider

getFacet

public CompositeType getFacet(String name)

Description copied from interface: TypeProvider

Gets a facet.

Specified by:

getFacet in interface TypeProvider

getNoPerDocumentQueryFacets

public Set<String> getNoPerDocumentQueryFacets()

Description copied from interface: TypeProvider

Finds which facets are configured as no-per-instance-query.

Specified by:

getNoPerDocumentQueryFacets in interface TypeProvider

recomputeDocumentTypes

protected void recomputeDocumentTypes()

mergeDocumentTypeDescriptors

protected DocumentTypeDescriptor mergeDocumentTypeDescriptors(DocumentTypeDescriptor src,
                                                              DocumentTypeDescriptor dst)

recomputeDocumentType

protected DocumentType recomputeDocumentType(String name,
                                             Set<String> stack,
                                             Map<String,DocumentTypeDescriptor> dtds)

recomputeDocumentType

protected DocumentType recomputeDocumentType(String name,
                                             DocumentTypeDescriptor dtd,
                                             DocumentType parent)

registerDocumentType

protected void registerDocumentType(DocumentTypeImpl docType)

getDocumentType

public DocumentType getDocumentType(String name)

Description copied from interface: TypeProvider

Gets a document type.

Specified by:

getDocumentType in interface TypeProvider

getDocumentTypeNamesForFacet

public Set<String> getDocumentTypeNamesForFacet(String facet)

Description copied from interface: SchemaManager

Returns the names of all document types that have given facet.

Specified by:

getDocumentTypeNamesForFacet in interface SchemaManager

Returns:

null or the names as a guaranteed non-empty set.

getDocumentTypeNamesExtending

public Set<String> getDocumentTypeNamesExtending(String docTypeName)

Description copied from interface: SchemaManager

Return the names of all document types extending the given one, which is included.

Specified by:

getDocumentTypeNamesExtending in interface SchemaManager

Returns:

null or the set of names.

getDocumentTypes

public DocumentType[] getDocumentTypes()

Description copied from interface: TypeProvider

Gets the list of document types.

Specified by:

getDocumentTypes in interface TypeProvider

getDocumentTypesCount

public int getDocumentTypesCount()

Specified by:

getDocumentTypesCount in interface SchemaManager

hasSuperType

public boolean hasSuperType(String docType,
                            String superType)

Description copied from interface: SchemaManager

Returns true if docType is or extends superType, false otherwise.

Specified by:

hasSuperType in interface SchemaManager

getAllowedSubTypes

public Set<String> getAllowedSubTypes(String typeName)

Description copied from interface: SchemaManager

Returns the types of the children that can be created inside a given type type.

Specified by:

getAllowedSubTypes in interface SchemaManager

recomputeProxies

protected void recomputeProxies()

getProxySchemas

public List<Schema> getProxySchemas(String docType)

Description copied from interface: TypeProvider

Gets the schemas on a proxy for a document of the given type.

Specified by:

getProxySchemas in interface TypeProvider

isProxySchema

public boolean isProxySchema(String schema,
                             String docType)

Description copied from interface: TypeProvider

Checks if a schema is on a proxy for a document of the given type.

Specified by:

isProxySchema in interface TypeProvider

getField

public Field getField(String xpath)

Description copied from interface: SchemaManager

Returns the field with given xpath, or null if not found.

Specified by:

getField in interface SchemaManager

getField

public Field getField(Field parent,
                      String subFieldName)

Description copied from interface: SchemaManager

Returns the field with given parent field and sub name, or null if not found.

Specified by:

getField in interface SchemaManager

getField

protected Field getField(Field parent,
                         String subFieldName,
                         boolean finalCall)

resolveSubField

protected Field resolveSubField(ListType listType,
                                String subName,
                                boolean fallbackOnSubElement)

flushPendingsRegistration

public void flushPendingsRegistration()

registerRecomputeCallback

public void registerRecomputeCallback(Runnable callback)

Since:

8.10

unregisterRecomputeCallback

public void unregisterRecomputeCallback(Runnable callback)

Since:

8.10

executeRecomputeCallbacks

protected void executeRecomputeCallbacks()

Since:

8.10

registerPropertyDeprecation

public void registerPropertyDeprecation(PropertyDeprecationDescriptor descriptor)

Since:

9.2

unregisterPropertyDeprecation

public void unregisterPropertyDeprecation(PropertyDeprecationDescriptor descriptor)

Since:

9.2

getDeprecatedProperties

public PropertyDeprecationHandler getDeprecatedProperties()

Specified by:

getDeprecatedProperties in interface SchemaManager

Returns:

the deprecated properties handler

Since:

9.2

getRemovedProperties

public PropertyDeprecationHandler getRemovedProperties()

Specified by:

getRemovedProperties in interface SchemaManager

Returns:

the removed properties handler

Since:

9.2

getClearComplexPropertyBeforeSet

public boolean getClearComplexPropertyBeforeSet()

Description copied from interface: SchemaManager

Whether or not to ignore any previous values when setting complex properties.

Specified by:

getClearComplexPropertyBeforeSet in interface SchemaManager

Returns:

true if setting a complex property ignores any previous values

getAllowVersionWriteForDublinCore

public boolean getAllowVersionWriteForDublinCore()

Description copied from interface: SchemaManager

Whether we allow to write the dublincore schema on a version.

Specified by:

getAllowVersionWriteForDublinCore in interface SchemaManager

Returns:

true if write to the dublincore schema of a version is allowed