Package org.nuxeo.ecm.core.schema
Interface SchemaManager
-
- All Superinterfaces:
PropertyCharacteristicHandler
,TypeProvider
- All Known Implementing Classes:
SchemaManagerImpl
public interface SchemaManager extends TypeProvider, PropertyCharacteristicHandler
The Schema Manager manages core document types, schemas, facets and field types.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Set<String>
getAllowedSubTypes(String type)
Returns the types of the children that can be created inside a giventype
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()
Deprecated.since 11.1, usePropertyCharacteristicHandler
methods insteadSet<String>
getDocumentTypeNamesExtending(String docType)
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.int
getDocumentTypesCount()
Field
getField(String xpath)
Returns the field with given xpath, or null if not found.Field
getField(Field field, String subFieldName)
Returns the field with given parent field and sub name, or null if not found.PropertyDeprecationHandler
getRemovedProperties()
Deprecated.since 11.1, usePropertyCharacteristicHandler
methods insteadSchema
getSchemaFromPrefix(String schemaPrefix)
Schema
getSchemaFromURI(String schemaURI)
Deprecated.since 11.1, seems unusedboolean
hasSuperType(String docType, String superType)
Returns true ifdocType
is or extendssuperType
, false otherwise.-
Methods inherited from interface org.nuxeo.ecm.core.schema.PropertyCharacteristicHandler
getDeprecatedProperties, getFallback, getRemovedProperties, isDeprecated, isRemoved, isSecured
-
Methods inherited from interface org.nuxeo.ecm.core.schema.TypeProvider
getDocumentType, getDocumentTypes, getFacet, getFacets, getNoPerDocumentQueryFacets, getProxySchemas, getSchema, getSchemas, getSpecialDocumentTypes, isProxySchema
-
-
-
-
Method Detail
-
getField
Field getField(Field field, String subFieldName)
Returns the field with given parent field and sub name, or null if not found.- Since:
- 7.2
-
getSchemaFromPrefix
Schema getSchemaFromPrefix(String schemaPrefix)
-
getSchemaFromURI
@Deprecated(since="11.1") Schema getSchemaFromURI(String schemaURI)
Deprecated.since 11.1, seems unused
-
getDocumentTypeNamesForFacet
Set<String> getDocumentTypeNamesForFacet(String facet)
Returns the names of all document types that have given facet.- Returns:
- null or the names as a guaranteed non-empty set.
-
getDocumentTypeNamesExtending
Set<String> getDocumentTypeNamesExtending(String docType)
Return the names of all document types extending the given one, which is included.- Returns:
- null or the set of names.
-
getDocumentTypesCount
int getDocumentTypesCount()
-
hasSuperType
boolean hasSuperType(String docType, String superType)
Returns true ifdocType
is or extendssuperType
, false otherwise.- Since:
- 5.9.4
-
getAllowedSubTypes
Set<String> getAllowedSubTypes(String type)
Returns the types of the children that can be created inside a giventype
type.- Since:
- 8.4
-
getDeprecatedProperties
@Deprecated(since="11.1") PropertyDeprecationHandler getDeprecatedProperties()
Deprecated.since 11.1, usePropertyCharacteristicHandler
methods instead- Returns:
- the deprecated properties handler
- Since:
- 9.2
-
getRemovedProperties
@Deprecated(since="11.1") PropertyDeprecationHandler getRemovedProperties()
Deprecated.since 11.1, usePropertyCharacteristicHandler
methods instead- Returns:
- the removed properties handler
- Since:
- 9.2
-
getClearComplexPropertyBeforeSet
boolean getClearComplexPropertyBeforeSet()
Whether or not to ignore any previous values when setting complex properties.- Returns:
true
if setting a complex property ignores any previous values- Since:
- 9.3
-
getAllowVersionWriteForDublinCore
boolean getAllowVersionWriteForDublinCore()
Whether we allow to write the dublincore schema on a version.- Returns:
true
if write to the dublincore schema of a version is allowed- Since:
- 10.3
-
-