org.nuxeo.ecm.core.schema

Class DocumentTypeImpl

java.lang.Object

org.nuxeo.ecm.core.schema.types.AbstractType

org.nuxeo.ecm.core.schema.types.ComplexTypeImpl

org.nuxeo.ecm.core.schema.types.CompositeTypeImpl

org.nuxeo.ecm.core.schema.DocumentTypeImpl

All Implemented Interfaces:

Serializable, DocumentType, ComplexType, CompositeType, Type

public class DocumentTypeImpl
extends CompositeTypeImpl
implements DocumentType

Implementation of a document type.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.core.schema.types.AbstractType

EMPTY_SUPERTYPES

Fields inherited from interface org.nuxeo.ecm.core.schema.types.Type

ANY

Constructor Summary

Constructors

Constructor and Description
DocumentTypeImpl(String name)
DocumentTypeImpl(String name, DocumentType superType, List<Schema> schemas, Collection<String> facets, PrefetchInfo prefetchInfo) Constructs a document type.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getFacets() Gets all the facets of this document type.
PrefetchInfo	getPrefetchInfo() Gets the prefetch info, or null if no prefetch is defined.
boolean	hasFacet(String facetName) Returns true if this document type has the given facetName facet, false otherwise.
boolean	isFile() Tests whether this type describes a document (not a folder!) or not.
boolean	isFolder() Tests whether this type describes a folder or not.
boolean	isOrdered() Tests whether this type describe an ordered folder or not.
void	setPrefetchInfo(PrefetchInfo prefetchInfo)

Methods inherited from class org.nuxeo.ecm.core.schema.types.CompositeTypeImpl

getField, getSchema, getSchemaNames, getSchemas, hasSchema, hasSchemas, isComplexType, isCompositeType, validate

Methods inherited from class org.nuxeo.ecm.core.schema.types.ComplexTypeImpl

addField, canonicalXPath, convert, getField, getFields, getFieldsCount, getNamespace, hasField, hasFields, newInstance, toString

Methods inherited from class org.nuxeo.ecm.core.schema.types.AbstractType

decode, encode, getName, getSchema, getSchemaName, getSuperType, getTypeHierarchy, isAny, isAnyType, isListType, isSimpleType, isSuperTypeOf

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.schema.types.CompositeType

getSchema, getSchemaNames, getSchemas, hasSchema, hasSchemas

Methods inherited from interface org.nuxeo.ecm.core.schema.types.ComplexType

addField, getField, getField, getFields, getFieldsCount, getNamespace, hasField, hasFields

Methods inherited from interface org.nuxeo.ecm.core.schema.types.Type

convert, decode, encode, getName, getSchema, getSchemaName, getSuperType, getTypeHierarchy, isAnyType, isComplexType, isCompositeType, isListType, isSimpleType, isSuperTypeOf, newInstance, validate

Constructor Detail

DocumentTypeImpl

public DocumentTypeImpl(String name,
                DocumentType superType,
                List<Schema> schemas,
                Collection<String> facets,
                PrefetchInfo prefetchInfo)

Constructs a document type. Schemas and facets must include those from the super type.

DocumentTypeImpl

public DocumentTypeImpl(String name)

Method Detail

setPrefetchInfo

public void setPrefetchInfo(PrefetchInfo prefetchInfo)

getPrefetchInfo

public PrefetchInfo getPrefetchInfo()

Description copied from interface: DocumentType

Gets the prefetch info, or null if no prefetch is defined.

If the prefetch info is not null, the caller should use it when instantiating a document to preload the fields defined by the prefetch info.

If no prefetch is specified by the document type, the caller is free to use a default prefetch info or no prefetch at all.

Specified by:

getPrefetchInfo in interface DocumentType

Returns:

the prefetch info or null

isFile

public boolean isFile()

Description copied from interface: DocumentType

Tests whether this type describes a document (not a folder!) or not.

Specified by:

isFile in interface DocumentType

Returns:

true if the type describes a document folder, otherwise returns false

isFolder

public boolean isFolder()

Description copied from interface: DocumentType

Tests whether this type describes a folder or not.

Specified by:

isFolder in interface DocumentType

Returns:

true if the type describes a folder, otherwise returns false

isOrdered

public boolean isOrdered()

Description copied from interface: DocumentType

Tests whether this type describe an ordered folder or not.

Specified by:

isOrdered in interface DocumentType

Returns:

true if the type describes an ordered folder, otherwise returns false

getFacets

public Set<String> getFacets()

Description copied from interface: DocumentType

Gets all the facets of this document type.

Facets inherited from parents are taken into account.

Specified by:

getFacets in interface DocumentType

Returns:

the facets

hasFacet

public boolean hasFacet(String facetName)

Description copied from interface: DocumentType

Returns true if this document type has the given facetName facet, false otherwise.

Specified by:

hasFacet in interface DocumentType