com.orientechnologies.orient.core.metadata.schema

Interface OClass

All Superinterfaces:

Comparable<OClass>

All Known Subinterfaces:

OView

All Known Implementing Classes:

OClassAbstractDelegate, OClassDistributed, OClassEmbedded, OClassImpl, OClassRemote, OImmutableClass, OImmutableView, OrientEdgeType, OrientElementType, OrientVertexType, OViewEmbedded, OViewImpl, OViewRemote

public interface OClass
extends Comparable<OClass>

Schema class

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OClass.ATTRIBUTES
static class	OClass.INDEX_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDGE_CLASS_NAME
static String	VERTEX_CLASS_NAME

Method Summary

Modifier and Type	Method and Description
OClass	addCluster(String iClusterName)
OClass	addClusterId(int iId)
OClass	addSuperClass(OClass superClass)
boolean	areIndexed(Collection<String> fields) Indicates whether given fields are contained as first key fields in class indexes.
boolean	areIndexed(String... fields)
void	clearCustom()
long	count() Returns the number of the records of this class considering also subclasses (polymorphic).
long	count(boolean iPolymorphic) Returns the number of the records of this class and based on polymorphic parameter it consider or not the subclasses.
OIndex	createIndex(String iName, OClass.INDEX_TYPE iType, OProgressListener iProgressListener, String... fields) Creates database index that is based on passed in field names.
OIndex	createIndex(String iName, OClass.INDEX_TYPE iType, String... fields) Creates database index that is based on passed in field names.
OIndex	createIndex(String iName, String iType, OProgressListener iProgressListener, ODocument metadata, String... fields) Creates database index that is based on passed in field names.
OIndex	createIndex(String iName, String iType, OProgressListener iProgressListener, ODocument metadata, String algorithm, String... fields) Creates database index that is based on passed in field names.
OIndex	createIndex(String iName, String iType, String... fields) Creates database index that is based on passed in field names.
OProperty	createProperty(String iPropertyName, OType iType)
OProperty	createProperty(String iPropertyName, OType iType, OClass iLinkedClass)
OProperty	createProperty(String iPropertyName, OType iType, OClass iLinkedClass, boolean iUnsafe) Create a property in the class with the specified options.
OProperty	createProperty(String iPropertyName, OType iType, OType iLinkedType)
OProperty	createProperty(String iPropertyName, OType iType, OType iLinkedType, boolean iUnsafe) Create a property in the class with the specified options.
Collection<OProperty>	declaredProperties()
void	dropProperty(String iPropertyName)
boolean	existsProperty(String iPropertyName)
Object	get(OClass.ATTRIBUTES iAttribute)
Collection<OClass>	getAllBaseClasses() Deprecated.
Collection<OClass>	getAllSubclasses()
Collection<OClass>	getAllSuperClasses()
OIndex	getAutoShardingIndex() Returns the auto sharding index configured for the class if any.
Collection<OClass>	getBaseClasses() Deprecated.
OIndex	getClassIndex(String iName) Returns index instance by database index name.
Set<OIndex>	getClassIndexes()
void	getClassIndexes(Collection<OIndex> indexes) Internal.
Set<OIndex>	getClassInvolvedIndexes(Collection<String> fields) Returns list of indexes that contain passed in fields names as their first keys.
Set<OIndex>	getClassInvolvedIndexes(String... fields)
float	getClassOverSize()
int	getClusterForNewInstance(ODocument doc)
int[]	getClusterIds()
OClusterSelectionStrategy	getClusterSelection()
String	getCustom(String iName)
Set<String>	getCustomKeys()
int	getDefaultClusterId()
String	getDescription()
Collection<OProperty>	getIndexedProperties()
Set<OIndex>	getIndexes()
void	getIndexes(Collection<OIndex> indexes) Internal.
Set<OIndex>	getInvolvedIndexes(Collection<String> fields) Returns list of indexes that contain passed in fields names as their first keys.
Set<OIndex>	getInvolvedIndexes(String... fields) Returns list of indexes that contain passed in fields names as their first keys.
String	getName()
float	getOverSize() Returns the oversize factor.
int[]	getPolymorphicClusterIds()
OProperty	getProperty(String iPropertyName)
String	getShortName()
long	getSize()
String	getStreamableName()
Collection<OClass>	getSubclasses()
OClass	getSuperClass() Deprecated.
List<OClass>	getSuperClasses()
List<String>	getSuperClassesNames()
boolean	hasClusterId(int clusterId)
boolean	hasPolymorphicClusterId(int clusterId)
boolean	hasSuperClasses()
boolean	isAbstract()
boolean	isEdgeType()
boolean	isStrictMode()
boolean	isSubClassOf(OClass iClass) Returns true if the current instance extends the passed schema class (iClass).
boolean	isSubClassOf(String iClassName) Tells if the current instance extends the passed schema class (iClass).
boolean	isSuperClassOf(OClass iClass) Returns true if the passed schema class (iClass) extends the current instance.
boolean	isVertexType()
Collection<OProperty>	properties()
Map<String,OProperty>	propertiesMap()
OClass	removeClusterId(int iId)
void	removeCustom(String iName)
OClass	removeSuperClass(OClass superClass)
OClass	set(OClass.ATTRIBUTES attribute, Object iValue)
OClass	setAbstract(boolean iAbstract)
OClass	setClusterSelection(OClusterSelectionStrategy clusterSelection)
OClass	setClusterSelection(String iStrategyName)
OClass	setCustom(String iName, String iValue)
void	setDefaultClusterId(int iDefaultClusterId)
OClass	setDescription(String iDescription)
OClass	setName(String iName)
OClass	setOverSize(float overSize) Sets the oversize factor.
OClass	setShortName(String shortName)
OClass	setStrictMode(boolean iMode)
OClass	setSuperClass(OClass iSuperClass) Deprecated.
OClass	setSuperClasses(List<? extends OClass> classes)
void	truncate() Truncates all the clusters the class uses.
OClass	truncateCluster(String clusterName) Removes all data in the cluster with given name.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EDGE_CLASS_NAME

static final String EDGE_CLASS_NAME

See Also:

Constant Field Values

VERTEX_CLASS_NAME

static final String VERTEX_CLASS_NAME

See Also:

Constant Field Values

Method Detail

isAbstract

boolean isAbstract()

setAbstract

OClass setAbstract(boolean iAbstract)

isStrictMode

boolean isStrictMode()

setStrictMode

OClass setStrictMode(boolean iMode)

getSuperClass

@Deprecated
OClass getSuperClass()

Deprecated.

setSuperClass

@Deprecated
OClass setSuperClass(OClass iSuperClass)

Deprecated.

hasSuperClasses

boolean hasSuperClasses()

getSuperClassesNames

List<String> getSuperClassesNames()

getSuperClasses

List<OClass> getSuperClasses()

setSuperClasses

OClass setSuperClasses(List<? extends OClass> classes)

addSuperClass

OClass addSuperClass(OClass superClass)

removeSuperClass

OClass removeSuperClass(OClass superClass)

getName

String getName()

setName

OClass setName(String iName)

getDescription

String getDescription()

setDescription

OClass setDescription(String iDescription)

getStreamableName

String getStreamableName()

declaredProperties

Collection<OProperty> declaredProperties()

properties

Collection<OProperty> properties()

propertiesMap

Map<String,OProperty> propertiesMap()

getIndexedProperties

Collection<OProperty> getIndexedProperties()

getProperty

OProperty getProperty(String iPropertyName)

createProperty

OProperty createProperty(String iPropertyName,
                         OType iType)

createProperty

OProperty createProperty(String iPropertyName,
                         OType iType,
                         OClass iLinkedClass)

createProperty

OProperty createProperty(String iPropertyName,
                         OType iType,
                         OClass iLinkedClass,
                         boolean iUnsafe)

Create a property in the class with the specified options.

Parameters:

iPropertyName - the name of the property.

iType - the type of the property.

iLinkedClass - in case of property of type LINK,LINKLIST,LINKSET,LINKMAP,EMBEDDED,EMBEDDEDLIST,EMBEDDEDSET,EMBEDDEDMAP can be specified a linked class in all the other cases should be null

iUnsafe - if true avoid to check the persistent data for compatibility, should be used only if all persistent data is compatible with the property

Returns:

the created property.

createProperty

OProperty createProperty(String iPropertyName,
                         OType iType,
                         OType iLinkedType)

createProperty

OProperty createProperty(String iPropertyName,
                         OType iType,
                         OType iLinkedType,
                         boolean iUnsafe)

Create a property in the class with the specified options.

Parameters:

iPropertyName - the name of the property.

iType - the type of the property.

iLinkedType - in case of property of type EMBEDDEDLIST,EMBEDDEDSET,EMBEDDEDMAP can be specified a linked type in all the other cases should be null

iUnsafe - if true avoid to check the persistent data for compatibility, should be used only if all persistent data is compatible with the property

Returns:

the created property.

dropProperty

void dropProperty(String iPropertyName)

existsProperty

boolean existsProperty(String iPropertyName)

getClusterForNewInstance

int getClusterForNewInstance(ODocument doc)

getDefaultClusterId

int getDefaultClusterId()

setDefaultClusterId

void setDefaultClusterId(int iDefaultClusterId)

getClusterIds

int[] getClusterIds()

addClusterId

OClass addClusterId(int iId)

getClusterSelection

OClusterSelectionStrategy getClusterSelection()

setClusterSelection

OClass setClusterSelection(OClusterSelectionStrategy clusterSelection)

setClusterSelection

OClass setClusterSelection(String iStrategyName)

addCluster

OClass addCluster(String iClusterName)

truncateCluster

OClass truncateCluster(String clusterName)

Removes all data in the cluster with given name. As result indexes for this class will be rebuilt.

Parameters:

clusterName - Name of cluster to be truncated.

Returns:

Instance of current object.

removeClusterId

OClass removeClusterId(int iId)

getPolymorphicClusterIds

int[] getPolymorphicClusterIds()

getBaseClasses

@Deprecated
Collection<OClass> getBaseClasses()

Deprecated.

getAllBaseClasses

@Deprecated
Collection<OClass> getAllBaseClasses()

Deprecated.

getSubclasses

Collection<OClass> getSubclasses()

Returns:

all the subclasses (one level hierarchy only)

getAllSubclasses

Collection<OClass> getAllSubclasses()

Returns:

all the subclass hierarchy

getAllSuperClasses

Collection<OClass> getAllSuperClasses()

Returns:

all recursively collected super classes

getSize

long getSize()

getClassOverSize

float getClassOverSize()

getOverSize

float getOverSize()

Returns the oversize factor. Oversize is used to extend the record size by a factor to avoid defragmentation upon updates. 0 or 1.0 means no oversize.

Returns:

Oversize factor

See Also:

setOverSize(float)

setOverSize

OClass setOverSize(float overSize)

Sets the oversize factor. Oversize is used to extend the record size by a factor to avoid defragmentation upon updates. 0 or 1.0 means no oversize. Default is 0.

Returns:

Oversize factor

See Also:

getOverSize()

count

long count()

Returns the number of the records of this class considering also subclasses (polymorphic).

count

long count(boolean iPolymorphic)

Returns the number of the records of this class and based on polymorphic parameter it consider or not the subclasses.

truncate

void truncate()
       throws IOException

Truncates all the clusters the class uses.

Throws:

IOException

isSubClassOf

boolean isSubClassOf(String iClassName)

Tells if the current instance extends the passed schema class (iClass).

Parameters:

iClassName -

Returns:

true if the current instance extends the passed schema class (iClass).

See Also:

isSuperClassOf(OClass)

isSubClassOf

boolean isSubClassOf(OClass iClass)

Returns true if the current instance extends the passed schema class (iClass).

Parameters:

iClass -

Returns:

true if the current instance extends the passed schema class (iClass).

See Also:

isSuperClassOf(OClass)

isSuperClassOf

boolean isSuperClassOf(OClass iClass)

Returns true if the passed schema class (iClass) extends the current instance.

Parameters:

iClass -

Returns:

Returns true if the passed schema class extends the current instance.

See Also:

isSubClassOf(OClass)

getShortName

String getShortName()

setShortName

OClass setShortName(String shortName)

get

Object get(OClass.ATTRIBUTES iAttribute)

set

OClass set(OClass.ATTRIBUTES attribute,
           Object iValue)

createIndex

OIndex createIndex(String iName,
                   OClass.INDEX_TYPE iType,
                   String... fields)

Creates database index that is based on passed in field names. Given index will be added into class instance and associated with database index.

Parameters:

fields - Field names from which index will be created.

iName - Database index name

iType - Index type.

Returns:

Class index registered inside of given class ans associated with database index.

createIndex

OIndex createIndex(String iName,
                   String iType,
                   String... fields)

Creates database index that is based on passed in field names. Given index will be added into class instance and associated with database index.

Parameters:

fields - Field names from which index will be created.

iName - Database index name

iType - Index type.

Returns:

Class index registered inside of given class ans associated with database index.

createIndex

OIndex createIndex(String iName,
                   OClass.INDEX_TYPE iType,
                   OProgressListener iProgressListener,
                   String... fields)

Creates database index that is based on passed in field names. Given index will be added into class instance.

Parameters:

fields - Field names from which index will be created.

iName - Database index name.

iType - Index type.

iProgressListener - Progress listener.

Returns:

Class index registered inside of given class ans associated with database index.

createIndex

OIndex createIndex(String iName,
                   String iType,
                   OProgressListener iProgressListener,
                   ODocument metadata,
                   String algorithm,
                   String... fields)

Creates database index that is based on passed in field names. Given index will be added into class instance.

Parameters:

iName - Database index name.

iType - Index type.

iProgressListener - Progress listener.

metadata - Additional parameters which will be added in index configuration document as "metadata" field.

algorithm - Algorithm to use for indexing.

fields - Field names from which index will be created. @return Class index registered inside of given class ans associated with database index.

createIndex

OIndex createIndex(String iName,
                   String iType,
                   OProgressListener iProgressListener,
                   ODocument metadata,
                   String... fields)

Creates database index that is based on passed in field names. Given index will be added into class instance.

Parameters:

iName - Database index name.

iType - Index type.

iProgressListener - Progress listener.

metadata - Additional parameters which will be added in index configuration document as "metadata" field.

fields - Field names from which index will be created. @return Class index registered inside of given class ans associated with database index.

getInvolvedIndexes

Set<OIndex> getInvolvedIndexes(Collection<String> fields)

Returns list of indexes that contain passed in fields names as their first keys. Order of fields does not matter.

All indexes sorted by their count of parameters in ascending order. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

See Also:

OIndexDefinition.getParamCount()

getInvolvedIndexes

Set<OIndex> getInvolvedIndexes(String... fields)

Returns list of indexes that contain passed in fields names as their first keys. Order of fields does not matter.

All indexes sorted by their count of parameters in ascending order. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

See Also:

getInvolvedIndexes(java.util.Collection)

getClassInvolvedIndexes

Set<OIndex> getClassInvolvedIndexes(Collection<String> fields)

Returns list of indexes that contain passed in fields names as their first keys. Order of fields does not matter.

Indexes that related only to the given class will be returned.

Parameters:

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

See Also:

OIndexDefinition.getParamCount()

getClassInvolvedIndexes

Set<OIndex> getClassInvolvedIndexes(String... fields)

Parameters:

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

See Also:

getClassInvolvedIndexes(java.util.Collection)

areIndexed

boolean areIndexed(Collection<String> fields)

Indicates whether given fields are contained as first key fields in class indexes. Order of fields does not matter. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

fields - Field names.

Returns:

true if given fields are contained as first key fields in class indexes.

areIndexed

boolean areIndexed(String... fields)

Parameters:

fields - Field names.

Returns:

true if given fields are contained as first key fields in class indexes.

See Also:

areIndexed(java.util.Collection)

getClassIndex

OIndex getClassIndex(String iName)

Returns index instance by database index name.

Parameters:

iName - Database index name.

Returns:

Index instance.

getClassIndexes

Set<OIndex> getClassIndexes()

Returns:

All indexes for given class, not the inherited ones.

getClassIndexes

void getClassIndexes(Collection<OIndex> indexes)

Internal. Copy all the indexes for given class, not the inherited ones, in the collection received as argument.

getIndexes

void getIndexes(Collection<OIndex> indexes)

Internal. All indexes for given class and its super classes.

getIndexes

Set<OIndex> getIndexes()

Returns:

All indexes for given class and its super classes.

getAutoShardingIndex

OIndex getAutoShardingIndex()

Returns the auto sharding index configured for the class if any.

isEdgeType

boolean isEdgeType()

Returns:

true if this class represents a subclass of an edge class (E)

isVertexType

boolean isVertexType()

Returns:

true if this class represents a subclass of a vertex class (V)

getCustom

String getCustom(String iName)

setCustom

OClass setCustom(String iName,
                 String iValue)

removeCustom

void removeCustom(String iName)

clearCustom

void clearCustom()

getCustomKeys

Set<String> getCustomKeys()

hasClusterId

boolean hasClusterId(int clusterId)

hasPolymorphicClusterId

boolean hasPolymorphicClusterId(int clusterId)