Package com.arcadedb.schema

Class LocalDocumentType

java.lang.Object

com.arcadedb.schema.LocalDocumentType

All Implemented Interfaces:

DocumentType

Direct Known Subclasses:

LocalEdgeType, LocalVertexType

public class LocalDocumentType
extends Object
implements DocumentType

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Integer>	bucketIds
protected Map<Integer,List<IndexInternal>>	bucketIndexesByBucket
protected List<Bucket>	buckets
protected BucketSelectionStrategy	bucketSelectionStrategy
protected List<Integer>	cachedPolymorphicBucketIds
protected List<Bucket>	cachedPolymorphicBuckets
protected Map<String,Object>	custom
protected RecordEventsRegistry	events
protected Map<List<String>,TypeIndex>	indexesByProperties
protected String	name
protected Map<String,Property>	properties
protected Set<String>	propertiesWithDefaultDefined
protected LocalSchema	schema
protected List<LocalDocumentType>	subTypes
protected List<LocalDocumentType>	superTypes

Constructor Summary

Constructors

Constructor	Description
LocalDocumentType(LocalSchema schema, String name)

Method Summary

Modifier and Type	Method	Description
DocumentType	addBucket(Bucket bucket)
protected void	addBucketInternal(Bucket bucket)
protected void	addIndexInternal(IndexInternal index, int bucketId, String[] propertyNames, TypeIndex propIndex)
DocumentType	addSuperType(DocumentType superType)
DocumentType	addSuperType(String superName)
LocalProperty	createProperty(String propertyName, Type propertyType)	Creates a new property with type `propertyType`.
LocalProperty	createProperty(String propertyName, Type propertyType, String ofType)	Creates a new property with type `propertyType`.
Property	createProperty(String propName, JSONObject prop)
Property	createProperty(String propertyName, Class<?> propertyType)	Creates a new property with type `propertyType`.
LocalProperty	createProperty(String propertyName, String propertyType)	Creates a new property with type `propertyType`.
TypeIndex	createTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String... propertyNames)
TypeIndex	createTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize)
TypeIndex	createTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize, Index.BuildIndexCallback callback)
TypeIndex	createTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize, LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy, Index.BuildIndexCallback callback)
Property	dropProperty(String propertyName)	Drops a property from the type.
boolean	equals(Object o)
boolean	existsPolymorphicProperty(String propertyName)
boolean	existsProperty(String propertyName)
Collection<TypeIndex>	getAllIndexes(boolean polymorphic)
Bucket	getBucketIdByRecord(Document record, boolean async)
List<Integer>	getBucketIds(boolean polymorphic)
int	getBucketIndexByKeys(Object[] keys, boolean async)
List<Bucket>	getBuckets(boolean polymorphic)
BucketSelectionStrategy	getBucketSelectionStrategy()
Set<String>	getCustomKeys()
Object	getCustomValue(String key)
RecordEvents	getEvents()
int	getFirstBucketId()
List<TypeIndex>	getIndexesByProperties(String property1, String... propertiesN)
List<TypeIndex>	getIndexesByProperties(Collection<String> properties)
List<Bucket>	getInvolvedBuckets()
String	getName()
Property	getOrCreateProperty(String propertyName, Type propertyType)	Returns a property by its name.
Property	getOrCreateProperty(String propertyName, Type propertyType, String ofType)	Returns a property by its name.
Property	getOrCreateProperty(String propertyName, Class<?> propertyType)	Returns a property by its name.
Property	getOrCreateProperty(String propertyName, String propertyType)	Returns a property by its name.
Property	getOrCreateProperty(String propertyName, String propertyType, String ofType)	Returns a property by its name.
TypeIndex	getOrCreateTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String... propertyNames)
TypeIndex	getOrCreateTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize)
TypeIndex	getOrCreateTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize, Index.BuildIndexCallback callback)
TypeIndex	getOrCreateTypeIndex(Schema.INDEX_TYPE indexType, boolean unique, String[] propertyNames, int pageSize, LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy, Index.BuildIndexCallback callback)
List<IndexInternal>	getPolymorphicBucketIndexByBucketId(int bucketId, List<String> filterByProperties)
TypeIndex	getPolymorphicIndexByProperties(String... properties)
TypeIndex	getPolymorphicIndexByProperties(List<String> properties)
Collection<? extends Property>	getPolymorphicProperties()	Returns all the properties defined in the type and subtypes.
Set<String>	getPolymorphicPropertiesWithDefaultDefined()
Set<String>	getPolymorphicPropertyNames()	Returns all the properties defined in the type and subtypes.
Collection<? extends Property>	getProperties()
Property	getPropertyIfExists(String propertyName)
Set<String>	getPropertyNames()	Returns all the properties defined in the type, not considering the ones inherited from subtypes.
Schema	getSchema()
List<DocumentType>	getSubTypes()	Returns the list of subtypes, in any, or an empty list in case the type has not subtypes defined.
List<DocumentType>	getSuperTypes()	Returns the list of super types if any, otherwise an empty collection.
boolean	hasBucket(String bucketName)
int	hashCode()
boolean	instanceOf(String type)	Returns true if the current type is the same or a subtype of `type` parameter.
boolean	isSubTypeOf(String type)
boolean	isSuperTypeOf(String type)
boolean	isTheSameAs(Object o)
MutableDocument	newRecord()
protected <RET> RET	recordFileChanges(Callable<Object> callback)
DocumentType	removeBucket(Bucket bucket)
void	removeBucketIndexInternal(Index index)
protected void	removeBucketInternal(Bucket bucket)
DocumentType	removeSuperType(DocumentType superType)	Removes a super type from the current type.
DocumentType	removeSuperType(String superTypeName)	Removes a super type (by its name) from the current type.
void	removeTypeIndexInternal(TypeIndex index)
DocumentType	setBucketSelectionStrategy(BucketSelectionStrategy selectionStrategy)
DocumentType	setBucketSelectionStrategy(String selectionStrategyName, Object... args)
Object	setCustomValue(String key, Object value)
DocumentType	setSuperTypes(List<DocumentType> newSuperTypes)	Set the type super types.
JSONObject	toJSON()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.arcadedb.schema.DocumentType

getPolymorphicProperty, getPolymorphicPropertyIfExists, getProperty, getType

Field Detail

schema

protected final LocalSchema schema

name

protected final String name

superTypes

protected final List<LocalDocumentType> superTypes

subTypes

protected final List<LocalDocumentType> subTypes

buckets

protected List<Bucket> buckets

cachedPolymorphicBuckets

protected List<Bucket> cachedPolymorphicBuckets

bucketIds

protected List<Integer> bucketIds

cachedPolymorphicBucketIds

protected List<Integer> cachedPolymorphicBucketIds

bucketSelectionStrategy

protected BucketSelectionStrategy bucketSelectionStrategy

properties

protected final Map<String,Property> properties

bucketIndexesByBucket

protected final Map<Integer,List<IndexInternal>> bucketIndexesByBucket

indexesByProperties

protected final Map<List<String>,TypeIndex> indexesByProperties

events

protected final RecordEventsRegistry events

custom

protected final Map<String,Object> custom

propertiesWithDefaultDefined

protected Set<String> propertiesWithDefaultDefined

Constructor Detail

LocalDocumentType

public LocalDocumentType(LocalSchema schema,
                         String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface DocumentType

newRecord

public MutableDocument newRecord()

Specified by:

newRecord in interface DocumentType

getEvents

public RecordEvents getEvents()

Specified by:

getEvents in interface DocumentType

getPolymorphicPropertiesWithDefaultDefined

public Set<String> getPolymorphicPropertiesWithDefaultDefined()

Specified by:

getPolymorphicPropertiesWithDefaultDefined in interface DocumentType

addSuperType

public DocumentType addSuperType(String superName)

Specified by:

addSuperType in interface DocumentType

addSuperType

public DocumentType addSuperType(DocumentType superType)

Specified by:

addSuperType in interface DocumentType

removeSuperType

public DocumentType removeSuperType(String superTypeName)

Removes a super type (by its name) from the current type.

Specified by:

removeSuperType in interface DocumentType

See Also:

removeSuperType(DocumentType), addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

removeSuperType

public DocumentType removeSuperType(DocumentType superType)

Removes a super type from the current type.

Specified by:

removeSuperType in interface DocumentType

See Also:

removeSuperType(String), addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

instanceOf

public boolean instanceOf(String type)

Returns true if the current type is the same or a subtype of `type` parameter.

Specified by:

instanceOf in interface DocumentType

Parameters:

type - the type name to check

See Also:

addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

getSuperTypes

public List<DocumentType> getSuperTypes()

Returns the list of super types if any, otherwise an empty collection.

Specified by:

getSuperTypes in interface DocumentType

See Also:

addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

setSuperTypes

public DocumentType setSuperTypes(List<DocumentType> newSuperTypes)

Set the type super types. Any previous configuration about supertypes will be replaced with this new list.

Specified by:

setSuperTypes in interface DocumentType

Parameters:

newSuperTypes - List of super types to assign

See Also:

addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

getSubTypes

public List<DocumentType> getSubTypes()

Returns the list of subtypes, in any, or an empty list in case the type has not subtypes defined.

Specified by:

getSubTypes in interface DocumentType

See Also:

addSuperType(DocumentType), addSuperType(String), addSuperType(DocumentType, boolean)

getPropertyNames

public Set<String> getPropertyNames()

Returns all the properties defined in the type, not considering the ones inherited from subtypes.

Specified by:

getPropertyNames in interface DocumentType

Returns:

Set containing all the names

See Also:

getPolymorphicPropertyNames()

getProperties

public Collection<? extends Property> getProperties()

Specified by:

getProperties in interface DocumentType

getPolymorphicProperties

public Collection<? extends Property> getPolymorphicProperties()

Returns all the properties defined in the type and subtypes.

Specified by:

getPolymorphicProperties in interface DocumentType

getPolymorphicPropertyNames

public Set<String> getPolymorphicPropertyNames()

Returns all the properties defined in the type and subtypes.

Specified by:

getPolymorphicPropertyNames in interface DocumentType

Returns:

Set containing all the names

See Also:

getPropertyNames()

createProperty

public LocalProperty createProperty(String propertyName,
                                    String propertyType)

Creates a new property with type `propertyType`.

Specified by:

createProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type by type name @String

createProperty

public Property createProperty(String propertyName,
                               Class<?> propertyType)

Creates a new property with type `propertyType`.

Specified by:

createProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type as Java @Class

createProperty

public Property createProperty(String propName,
                               JSONObject prop)

Specified by:

createProperty in interface DocumentType

createProperty

public LocalProperty createProperty(String propertyName,
                                    Type propertyType)

Creates a new property with type `propertyType`.

Specified by:

createProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type as @Type

createProperty

public LocalProperty createProperty(String propertyName,
                                    Type propertyType,
                                    String ofType)

Creates a new property with type `propertyType`.

Specified by:

createProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type as @Type

ofType - Linked type. For List the type contained in the list. For RID the schema type name.

getOrCreateProperty

public Property getOrCreateProperty(String propertyName,
                                    String propertyType)

Returns a property by its name. If the property does not exist, it is created with type `propertyType`.

Specified by:

getOrCreateProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type, by type name @String, to use in case the property does not exist and will be created

getOrCreateProperty

public Property getOrCreateProperty(String propertyName,
                                    String propertyType,
                                    String ofType)

Returns a property by its name. If the property does not exist, it is created with type `propertyType`.

Specified by:

getOrCreateProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type, by type name @String, to use in case the property does not exist and will be created

ofType - Linked type. For List the type contained in the list. For RID the schema type name.

getOrCreateProperty

public Property getOrCreateProperty(String propertyName,
                                    Class<?> propertyType)

Returns a property by its name. If the property does not exist, it is created with type `propertyType`.

Specified by:

getOrCreateProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type, as Java @Class, to use in case the property does not exist and will be created

getOrCreateProperty

public Property getOrCreateProperty(String propertyName,
                                    Type propertyType)

Returns a property by its name. If the property does not exist, it is created with type `propertyType`.

Specified by:

getOrCreateProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type, as @Type, to use in case the property does not exist and will be created

getOrCreateProperty

public Property getOrCreateProperty(String propertyName,
                                    Type propertyType,
                                    String ofType)

Returns a property by its name. If the property does not exist, it is created with type `propertyType`.

Specified by:

getOrCreateProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

propertyType - Property type, as @Type, to use in case the property does not exist and will be created

ofType - Linked type. For List the type contained in the list. For RID the schema type name.

dropProperty

public Property dropProperty(String propertyName)

Drops a property from the type. If there is any index on the property a @SchemaException is thrown.

Specified by:

dropProperty in interface DocumentType

Parameters:

propertyName - Property name to remove

Returns:

the property dropped if found

createTypeIndex

public TypeIndex createTypeIndex(Schema.INDEX_TYPE indexType,
                                 boolean unique,
                                 String... propertyNames)

Specified by:

createTypeIndex in interface DocumentType

createTypeIndex

public TypeIndex createTypeIndex(Schema.INDEX_TYPE indexType,
                                 boolean unique,
                                 String[] propertyNames,
                                 int pageSize)

Specified by:

createTypeIndex in interface DocumentType

createTypeIndex

public TypeIndex createTypeIndex(Schema.INDEX_TYPE indexType,
                                 boolean unique,
                                 String[] propertyNames,
                                 int pageSize,
                                 Index.BuildIndexCallback callback)

Specified by:

createTypeIndex in interface DocumentType

createTypeIndex

public TypeIndex createTypeIndex(Schema.INDEX_TYPE indexType,
                                 boolean unique,
                                 String[] propertyNames,
                                 int pageSize,
                                 LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy,
                                 Index.BuildIndexCallback callback)

Specified by:

createTypeIndex in interface DocumentType

getOrCreateTypeIndex

public TypeIndex getOrCreateTypeIndex(Schema.INDEX_TYPE indexType,
                                      boolean unique,
                                      String... propertyNames)

Specified by:

getOrCreateTypeIndex in interface DocumentType

getOrCreateTypeIndex

public TypeIndex getOrCreateTypeIndex(Schema.INDEX_TYPE indexType,
                                      boolean unique,
                                      String[] propertyNames,
                                      int pageSize)

Specified by:

getOrCreateTypeIndex in interface DocumentType

getOrCreateTypeIndex

public TypeIndex getOrCreateTypeIndex(Schema.INDEX_TYPE indexType,
                                      boolean unique,
                                      String[] propertyNames,
                                      int pageSize,
                                      Index.BuildIndexCallback callback)

Specified by:

getOrCreateTypeIndex in interface DocumentType

getOrCreateTypeIndex

public TypeIndex getOrCreateTypeIndex(Schema.INDEX_TYPE indexType,
                                      boolean unique,
                                      String[] propertyNames,
                                      int pageSize,
                                      LSMTreeIndexAbstract.NULL_STRATEGY nullStrategy,
                                      Index.BuildIndexCallback callback)

Specified by:

getOrCreateTypeIndex in interface DocumentType

getInvolvedBuckets

public List<Bucket> getInvolvedBuckets()

Specified by:

getInvolvedBuckets in interface DocumentType

getBuckets

public List<Bucket> getBuckets(boolean polymorphic)

Specified by:

getBuckets in interface DocumentType

getBucketIds

public List<Integer> getBucketIds(boolean polymorphic)

Specified by:

getBucketIds in interface DocumentType

addBucket

public DocumentType addBucket(Bucket bucket)

Specified by:

addBucket in interface DocumentType

removeBucket

public DocumentType removeBucket(Bucket bucket)

Specified by:

removeBucket in interface DocumentType

getBucketIdByRecord

public Bucket getBucketIdByRecord(Document record,
                                  boolean async)

Specified by:

getBucketIdByRecord in interface DocumentType

getBucketIndexByKeys

public int getBucketIndexByKeys(Object[] keys,
                                boolean async)

Specified by:

getBucketIndexByKeys in interface DocumentType

getBucketSelectionStrategy

public BucketSelectionStrategy getBucketSelectionStrategy()

Specified by:

getBucketSelectionStrategy in interface DocumentType

setBucketSelectionStrategy

public DocumentType setBucketSelectionStrategy(BucketSelectionStrategy selectionStrategy)

Specified by:

setBucketSelectionStrategy in interface DocumentType

setBucketSelectionStrategy

public DocumentType setBucketSelectionStrategy(String selectionStrategyName,
                                               Object... args)

Specified by:

setBucketSelectionStrategy in interface DocumentType

existsProperty

public boolean existsProperty(String propertyName)

Specified by:

existsProperty in interface DocumentType

existsPolymorphicProperty

public boolean existsPolymorphicProperty(String propertyName)

Specified by:

existsPolymorphicProperty in interface DocumentType

getPropertyIfExists

public Property getPropertyIfExists(String propertyName)

Specified by:

getPropertyIfExists in interface DocumentType

getAllIndexes

public Collection<TypeIndex> getAllIndexes(boolean polymorphic)

Specified by:

getAllIndexes in interface DocumentType

getPolymorphicBucketIndexByBucketId

public List<IndexInternal> getPolymorphicBucketIndexByBucketId(int bucketId,
                                                               List<String> filterByProperties)

Specified by:

getPolymorphicBucketIndexByBucketId in interface DocumentType

getIndexesByProperties

public List<TypeIndex> getIndexesByProperties(String property1,
                                              String... propertiesN)

Specified by:

getIndexesByProperties in interface DocumentType

getIndexesByProperties

public List<TypeIndex> getIndexesByProperties(Collection<String> properties)

Specified by:

getIndexesByProperties in interface DocumentType

getPolymorphicIndexByProperties

public TypeIndex getPolymorphicIndexByProperties(String... properties)

Specified by:

getPolymorphicIndexByProperties in interface DocumentType

getPolymorphicIndexByProperties

public TypeIndex getPolymorphicIndexByProperties(List<String> properties)

Specified by:

getPolymorphicIndexByProperties in interface DocumentType

getSchema

public Schema getSchema()

Specified by:

getSchema in interface DocumentType

toString

public String toString()

Overrides:

toString in class Object

isTheSameAs

public boolean isTheSameAs(Object o)

Specified by:

isTheSameAs in interface DocumentType

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

addIndexInternal

protected void addIndexInternal(IndexInternal index,
                                int bucketId,
                                String[] propertyNames,
                                TypeIndex propIndex)

removeTypeIndexInternal

public void removeTypeIndexInternal(TypeIndex index)

removeBucketIndexInternal

public void removeBucketIndexInternal(Index index)

addBucketInternal

protected void addBucketInternal(Bucket bucket)

removeBucketInternal

protected void removeBucketInternal(Bucket bucket)

hasBucket

public boolean hasBucket(String bucketName)

Specified by:

hasBucket in interface DocumentType

getFirstBucketId

public int getFirstBucketId()

Specified by:

getFirstBucketId in interface DocumentType

isSubTypeOf

public boolean isSubTypeOf(String type)

Specified by:

isSubTypeOf in interface DocumentType

isSuperTypeOf

public boolean isSuperTypeOf(String type)

Specified by:

isSuperTypeOf in interface DocumentType

getCustomKeys

public Set<String> getCustomKeys()

Specified by:

getCustomKeys in interface DocumentType

getCustomValue

public Object getCustomValue(String key)

Specified by:

getCustomValue in interface DocumentType

setCustomValue

public Object setCustomValue(String key,
                             Object value)

Specified by:

setCustomValue in interface DocumentType

toJSON

public JSONObject toJSON()

Specified by:

toJSON in interface DocumentType

recordFileChanges

protected <RET> RET recordFileChanges(Callable<Object> callback)