com.orientechnologies.orient.core.metadata.schema

Class OSchemaShared

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

com.orientechnologies.orient.core.metadata.schema.OSchemaShared

All Implemented Interfaces:

OCloseable, OSchema, OOrientShutdownListener, OOrientStartupListener, Serializable

public class OSchemaShared
extends ODocumentWrapperNoClass
implements OSchema, OCloseable, OOrientStartupListener, OOrientShutdownListener

Shared schema class. It's shared by all the database instances that point to the same storage.

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENT_VERSION_NUMBER
static int	VERSION_NUMBER_V4
static int	VERSION_NUMBER_V5

Fields inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

document

Constructor Summary

Constructors

Constructor and Description
OSchemaShared(boolean clustersCanNotBeSharedAmongClasses)

Method Summary

Modifier and Type	Method and Description
void	acquireSchemaReadLock()
void	acquireSchemaWriteLock()
int	addBlobCluster(int clusterId)
static Character	checkClassNameIfValid(String iName)
void	checkEmbedded(OStorage storage)
static Character	checkFieldNameIfValid(String iName)
void	close() Closes resources inside of call of OStorage#close().
int	countClasses()
void	create()
OClass	createAbstractClass(Class<?> iClass)
OClass	createAbstractClass(String className)
OClass	createAbstractClass(String iClassName, OClass... superClasses)
OClass	createAbstractClass(String className, OClass superClass)
OClass	createClass(Class<?> clazz)
OClass	createClass(String className)
OClass	createClass(String className, int[] clusterIds, OClass... superClasses)
OClass	createClass(String className, int clusters, OClass... superClasses)
OClass	createClass(String iClassName, OClass... superClasses)
OClass	createClass(String iClassName, OClass iSuperClass)
OClass	createClass(String className, OClass superClass, int[] clusterIds)
protected int	createClusterIfNeeded(String nameOrId)
OGlobalProperty	createGlobalProperty(String name, OType type, Integer id)
void	dropClass(String className)
boolean	existsClass(String iClassName)
protected OGlobalProperty	findOrCreateGlobalProperty(String name, OType type)
void	fromStream() Binds ODocument to POJO.
Set<Integer>	getBlobClusters()
OClass	getClass(Class<?> iClass)
OClass	getClass(String iClassName) Returns the OClass instance by class name.
OClass	getClassByClusterId(int clusterId)
Collection<OClass>	getClasses()
Set<OClass>	getClassesRelyOnCluster(String clusterName) Returns all the classes that rely on a cluster
protected int	getClusterId(String stringValue)
OClusterSelectionFactory	getClusterSelectionFactory()
List<OGlobalProperty>	getGlobalProperties()
OGlobalProperty	getGlobalPropertyById(int id)
ORID	getIdentity()
OClass	getOrCreateClass(String iClassName)
OClass	getOrCreateClass(String iClassName, OClass... superClasses)
OClass	getOrCreateClass(String iClassName, OClass superClass)
int	getVersion() Deprecated.
boolean	isClustersCanNotBeSharedAmongClasses()
OSchemaShared	load()
OImmutableSchema	makeSnapshot()
void	onPostIndexManagement() Callback invoked when the schema is loaded, after all the initializations.
void	onShutdown()
void	onStartup()
void	releaseSchemaReadLock()
void	releaseSchemaWriteLock()
void	releaseSchemaWriteLock(boolean iSave)
<RET extends ODocumentWrapper> RET	reload() Reloads the schema inside a storage's shared lock.
void	removeBlobCluster(String clusterName)
<RET extends ODocumentWrapper> RET	save() Avoid to handle this by user API.
<RET extends ODocumentWrapper> RET	save(String iClusterName) Avoid to handle this by user API.
OSchemaShared	setDirty()
ODocument	toStream() Binds POJO to ODocument.

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

fromStream, load, reload

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

equals, getDocument, hashCode, load, load, reload, toString

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_VERSION_NUMBER

public static final int CURRENT_VERSION_NUMBER

See Also:

Constant Field Values

VERSION_NUMBER_V4

public static final int VERSION_NUMBER_V4

See Also:

Constant Field Values

VERSION_NUMBER_V5

public static final int VERSION_NUMBER_V5

See Also:

Constant Field Values

Constructor Detail

OSchemaShared

public OSchemaShared(boolean clustersCanNotBeSharedAmongClasses)

Method Detail

onShutdown

public void onShutdown()

Specified by:

onShutdown in interface OOrientShutdownListener

onStartup

public void onStartup()

Specified by:

onStartup in interface OOrientStartupListener

checkClassNameIfValid

public static Character checkClassNameIfValid(String iName)
                                       throws OSchemaException

Throws:

OSchemaException

checkFieldNameIfValid

public static Character checkFieldNameIfValid(String iName)

makeSnapshot

public OImmutableSchema makeSnapshot()

Specified by:

makeSnapshot in interface OSchema

isClustersCanNotBeSharedAmongClasses

public boolean isClustersCanNotBeSharedAmongClasses()

getClusterSelectionFactory

public OClusterSelectionFactory getClusterSelectionFactory()

Specified by:

getClusterSelectionFactory in interface OSchema

countClasses

public int countClasses()

Specified by:

countClasses in interface OSchema

onPostIndexManagement

public void onPostIndexManagement()

Description copied from interface: OSchema

Callback invoked when the schema is loaded, after all the initializations.

Specified by:

onPostIndexManagement in interface OSchema

createClass

public OClass createClass(Class<?> clazz)

Specified by:

createClass in interface OSchema

createClass

public OClass createClass(String className)

Specified by:

createClass in interface OSchema

createClass

public OClass createClass(String iClassName,
                          OClass iSuperClass)

Specified by:

createClass in interface OSchema

createClass

public OClass createClass(String iClassName,
                          OClass... superClasses)

Specified by:

createClass in interface OSchema

getOrCreateClass

public OClass getOrCreateClass(String iClassName)

Specified by:

getOrCreateClass in interface OSchema

getOrCreateClass

public OClass getOrCreateClass(String iClassName,
                               OClass superClass)

Specified by:

getOrCreateClass in interface OSchema

getOrCreateClass

public OClass getOrCreateClass(String iClassName,
                               OClass... superClasses)

Specified by:

getOrCreateClass in interface OSchema

createAbstractClass

public OClass createAbstractClass(Class<?> iClass)

Specified by:

createAbstractClass in interface OSchema

createAbstractClass

public OClass createAbstractClass(String className)

Specified by:

createAbstractClass in interface OSchema

createAbstractClass

public OClass createAbstractClass(String className,
                                  OClass superClass)

Specified by:

createAbstractClass in interface OSchema

createAbstractClass

public OClass createAbstractClass(String iClassName,
                                  OClass... superClasses)

Specified by:

createAbstractClass in interface OSchema

createClass

public OClass createClass(String className,
                          OClass superClass,
                          int[] clusterIds)

Specified by:

createClass in interface OSchema

createClass

public OClass createClass(String className,
                          int[] clusterIds,
                          OClass... superClasses)

Specified by:

createClass in interface OSchema

createClass

public OClass createClass(String className,
                          int clusters,
                          OClass... superClasses)

Specified by:

createClass in interface OSchema

checkEmbedded

public void checkEmbedded(OStorage storage)

getClassByClusterId

public OClass getClassByClusterId(int clusterId)

Specified by:

getClassByClusterId in interface OSchema

dropClass

public void dropClass(String className)

Specified by:

dropClass in interface OSchema

reload

public <RET extends ODocumentWrapper> RET reload()

Reloads the schema inside a storage's shared lock.

Specified by:

reload in interface OSchema

Overrides:

reload in class ODocumentWrapperNoClass

existsClass

public boolean existsClass(String iClassName)

Specified by:

existsClass in interface OSchema

getClass

public OClass getClass(Class<?> iClass)

Specified by:

getClass in interface OSchema

getClass

public OClass getClass(String iClassName)

Description copied from interface: OSchema

Returns the OClass instance by class name.

If the class is not configured and the database has an entity manager with the requested class as registered, then creates a schema class for it at the fly.

If the database nor the entity manager have not registered class with specified name, returns null.

Specified by:

getClass in interface OSchema

Parameters:

iClassName - Name of the class to retrieve

Returns:

class instance or null if class with given name is not configured.

acquireSchemaReadLock

public void acquireSchemaReadLock()

releaseSchemaReadLock

public void releaseSchemaReadLock()

acquireSchemaWriteLock

public void acquireSchemaWriteLock()

releaseSchemaWriteLock

public void releaseSchemaWriteLock()

releaseSchemaWriteLock

public void releaseSchemaWriteLock(boolean iSave)

fromStream

public void fromStream()

Binds ODocument to POJO.

Specified by:

fromStream in class ODocumentWrapperNoClass

toStream

@OBeforeSerialization
public ODocument toStream()

Binds POJO to ODocument.

Overrides:

toStream in class ODocumentWrapper

getClasses

public Collection<OClass> getClasses()

Specified by:

getClasses in interface OSchema

getClassesRelyOnCluster

public Set<OClass> getClassesRelyOnCluster(String clusterName)

Description copied from interface: OSchema

Returns all the classes that rely on a cluster

Specified by:

getClassesRelyOnCluster in interface OSchema

Parameters:

clusterName - Cluster name

load

public OSchemaShared load()

Overrides:

load in class ODocumentWrapperNoClass

create

public void create()

Specified by:

create in interface OSchema

close

public void close()

Description copied from interface: OCloseable

Closes resources inside of call of OStorage#close(). So do not use locks when you call this method or you may have deadlock during storage close. This method is completely house keeping method and plays role of Object#finalize() in case of you need to clean up resources after storage is closed.

Specified by:

close in interface OCloseable

getVersion

@Deprecated
public int getVersion()

Deprecated.

Specified by:

getVersion in interface OSchema

getIdentity

public ORID getIdentity()

Specified by:

getIdentity in interface OSchema

save

public <RET extends ODocumentWrapper> RET save()

Avoid to handle this by user API.

Specified by:

save in interface OSchema

Overrides:

save in class ODocumentWrapperNoClass

save

public <RET extends ODocumentWrapper> RET save(String iClusterName)

Avoid to handle this by user API.

Overrides:

save in class ODocumentWrapperNoClass

setDirty

public OSchemaShared setDirty()

getGlobalPropertyById

public OGlobalProperty getGlobalPropertyById(int id)

Specified by:

getGlobalPropertyById in interface OSchema

createGlobalProperty

public OGlobalProperty createGlobalProperty(String name,
                                            OType type,
                                            Integer id)

Specified by:

createGlobalProperty in interface OSchema

getGlobalProperties

public List<OGlobalProperty> getGlobalProperties()

Specified by:

getGlobalProperties in interface OSchema

findOrCreateGlobalProperty

protected OGlobalProperty findOrCreateGlobalProperty(String name,
                                                     OType type)

addBlobCluster

public int addBlobCluster(int clusterId)

removeBlobCluster

public void removeBlobCluster(String clusterName)

getClusterId

protected int getClusterId(String stringValue)

createClusterIfNeeded

protected int createClusterIfNeeded(String nameOrId)

getBlobClusters

public Set<Integer> getBlobClusters()