|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentType
Document types are composite types made of several schemas.
Sample document types are Workspace, Section, Domain,... The list of builtin document type is visible at NXCore/OSGI-INF/CoreExtensions.xml.
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.core.schema.types.Type |
---|
ANY |
Method Summary | |
---|---|
void |
addSchemas(java.lang.String[] schemas)
Adds specified schemas to the document type. |
java.lang.String[] |
getChildrenTypes()
Gets the type names that can be used for children docs. |
java.util.Set<java.lang.String> |
getFacets()
Gets all the facets of this document type. |
PrefetchInfo |
getPrefetchInfo()
Gets the prefetch info, or null if no prefetch is defined. |
TypeRef<DocumentType> |
getRef()
Gets a proxy (or reference to this type). |
DocumentType[] |
getResolvedChildrenTypes()
Gets the resolved children doc types. |
boolean |
isChildTypeAllowed(java.lang.String name)
|
boolean |
isFile()
Tests whether this type describes a document (not a folder!) |
boolean |
isFolder()
Tests whether this type describes a folder or not. |
boolean |
isOrdered()
Tests whether this type describe an ordered folder or not. |
void |
setChildrenTypes(java.lang.String[] subTypes)
Sets the names of the allowed children doc types. |
void |
setDeclaredFacets(java.lang.String[] facets)
|
void |
setPrefetchInfo(PrefetchInfo prefetchInfo)
Sets the prefetch info. |
Methods inherited from interface org.nuxeo.ecm.core.schema.types.CompositeType |
---|
addSchema, addSchema, getSchema, getSchemaByPrefix, getSchemaNames, getSchemas, hasSchema, hasSchemas |
Methods inherited from interface org.nuxeo.ecm.core.schema.types.ComplexType |
---|
addField, addField, addField, addField, getField, getField, getFields, getFieldsCount, getNamespace, hasField, hasField, hasFields, isUnstructured |
Methods inherited from interface org.nuxeo.ecm.core.schema.types.Type |
---|
decode, encode, getHelper, getName, getSchema, getSchemaName, getSuperType, getTypeHierarchy, isAnyType, isComplexType, isCompositeType, isListType, isNotNull, isReadOnly, isSimpleType, isSuperTypeOf, newInstance, validate |
Methods inherited from interface org.nuxeo.ecm.core.schema.types.ValueConverter |
---|
convert |
Method Detail |
---|
void setPrefetchInfo(PrefetchInfo prefetchInfo)
The prefetch info describes which fields (or entire schemas) should be prefetched when instantiating a document.
This is primarily intended to optimize document initialization time.
The prefetch info is a string array of length multiple of 2 containing a sequence of pairs
composed by the schema name and the field name. If the field name is null then the entire schema
should be prefetched. Example: "common", null, "dublincore", "title"
prefetchInfo
- PrefetchInfo getPrefetchInfo()
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.
boolean isFile()
boolean isFolder()
boolean isOrdered()
java.util.Set<java.lang.String> getFacets()
Facets inherited from parents are taken into account.
void setDeclaredFacets(java.lang.String[] facets)
facets
- void addSchemas(java.lang.String[] schemas)
schemas
- TypeRef<DocumentType> getRef()
Type
getRef
in interface ComplexType
getRef
in interface CompositeType
getRef
in interface Type
void setChildrenTypes(java.lang.String[] subTypes)
Children types are document types allowed for the children of a document of the current type.
Type names may include '*' for all types.
subTypes
- null if no children types have been defined
(i.e. this type cannot have children), else an array with children typesjava.lang.String[] getChildrenTypes()
Returned types may include special group of types like '*'.
DocumentType[] getResolvedChildrenTypes()
Special group of types like '*' and exclusion filters if any are applied and the set of actual children types is computed and resolved into real doc types.
boolean isChildTypeAllowed(java.lang.String name)
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |