org.nuxeo.ecm.core.schema

Interface SchemaManager

All Superinterfaces:

TypeProvider

All Known Implementing Classes:

SchemaManagerImpl

public interface SchemaManager
extends TypeProvider

A Type Manager manages ECM document types, schemas and field types.

Author:

Bogdan Stefanescu

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Unregisters all types.
Set<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 prefixedName) Gets the field given a prefixed name.
TypeHelper	getHelper(String schema, String type)
Schema	getSchemaFromPrefix(String schemaPrefix)
Schema	getSchemaFromURI(String schemaURI)
int	getSchemasCount()
Type[]	getTypes(String schema) Gets the types defined by the given schema.
int	getTypesCount()
String	getXmlSchemaDefinition(String name) Get the schema definition.
void	registerDocumentType(DocumentType docType)
void	registerFacet(CompositeType facet)
void	registerHelper(String schema, String type, TypeHelper helper)
void	registerSchema(Schema schema)
void	registerType(Type type)
DocumentType	unregisterDocumentType(String name)
CompositeType	unregisterFacet(String name)
void	unregisterHelper(String schema, String type)
Schema	unregisterSchema(String name)
Type	unregisterType(String name)

Methods inherited from interface org.nuxeo.ecm.core.schema.TypeProvider

getDocumentType, getDocumentTypes, getFacet, getFacets, getSchema, getSchemas, getType, getType, getTypes

Method Detail

registerType

void registerType(Type type)

unregisterType

Type unregisterType(String name)

getTypes

Type[] getTypes(String schema)

Gets the types defined by the given schema.

Parameters:

schema -

Returns:

getTypesCount

int getTypesCount()

registerSchema

void registerSchema(Schema schema)

unregisterSchema

Schema unregisterSchema(String name)

getField

Field getField(String prefixedName)

Gets the field given a prefixed name.

Parameters:

prefixedName -

Returns:

the field or null if none

getSchemaFromPrefix

Schema getSchemaFromPrefix(String schemaPrefix)

getSchemaFromURI

Schema getSchemaFromURI(String schemaURI)

getSchemasCount

int getSchemasCount()

registerDocumentType

void registerDocumentType(DocumentType docType)

unregisterDocumentType

DocumentType unregisterDocumentType(String name)

registerFacet

void registerFacet(CompositeType facet)

unregisterFacet

CompositeType unregisterFacet(String name)

getDocumentTypeNamesForFacet

Set<String> getDocumentTypeNamesForFacet(String facet)

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

Parameters:

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.

Parameters:

docType -

Returns:

null or the set of names.

getDocumentTypesCount

int getDocumentTypesCount()

clear

void clear()

Unregisters all types. Useful for testing.

getXmlSchemaDefinition

String getXmlSchemaDefinition(String name)

Get the schema definition.

Returns:

registerHelper

void registerHelper(String schema,
                  String type,
                  TypeHelper helper)

unregisterHelper

void unregisterHelper(String schema,
                    String type)

getHelper

TypeHelper getHelper(String schema,
                   String type)