Package com.orientechnologies.orient.core.metadata.schema

Class OSchemaShared

java.lang.Object

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

All Implemented Interfaces:

OCloseable

Direct Known Subclasses:

OSchemaEmbedded, OSchemaRemote

public abstract class OSchemaShared
extends Object
implements OCloseable

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

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	OSchemaShared.ClusterIdsAreEmptyException

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,OClass>	classes
protected final Map<Integer,OClass>	clustersToClasses
protected final Map<Integer,OView>	clustersToViews
static final int	CURRENT_VERSION_NUMBER
protected OImmutableSchema	snapshot
static final int	VERSION_NUMBER_V4
static final int	VERSION_NUMBER_V5
protected final Map<String,OView>	views

Constructor Summary

Constructors

Constructor	Description
OSchemaShared()

Method Summary

Modifier and Type	Method	Description
void	acquireSchemaReadLock()
void	acquireSchemaWriteLock(ODatabaseDocumentInternal database)
int	addBlobCluster(ODatabaseDocumentInternal database, int clusterId)
protected void	addClusterClassMap(OClass cls)
protected void	addClusterViewMap(OView cls)
static Character	checkClassNameIfValid(String iName)
abstract void	checkEmbedded()
static Character	checkFieldNameIfValid(String iName)
void	close()	Closes resources inside of call of OStorage#close().
int	countClasses(ODatabaseDocumentInternal database)
int	countViews(ODatabaseDocumentInternal database)
void	create(ODatabaseDocumentInternal database)
OClass	createAbstractClass(ODatabaseDocumentInternal database, String className)
OClass	createAbstractClass(ODatabaseDocumentInternal database, String className, OClass superClass)
OClass	createAbstractClass(ODatabaseDocumentInternal database, String iClassName, OClass... superClasses)
OClass	createClass(ODatabaseDocumentInternal database, String className)
abstract OClass	createClass(ODatabaseDocumentInternal database, String className, int[] clusterIds, OClass... superClasses)
abstract OClass	createClass(ODatabaseDocumentInternal database, String className, int clusters, OClass... superClasses)
OClass	createClass(ODatabaseDocumentInternal database, String iClassName, OClass iSuperClass)
OClass	createClass(ODatabaseDocumentInternal database, String iClassName, OClass... superClasses)
OClass	createClass(ODatabaseDocumentInternal database, String className, OClass superClass, int[] clusterIds)
abstract boolean	createClassIfNotExists(ODatabaseDocumentInternal session, String className)
abstract boolean	createClassIfNotExists(ODatabaseDocumentInternal session, String className, OClass... superclasses)
protected abstract OClassImpl	createClassInstance(String name)
int	createClusterIfNeeded(ODatabaseDocumentInternal database, String nameOrId)
OGlobalProperty	createGlobalProperty(String name, OType type, Integer id)
abstract OView	createView(ODatabaseDocumentInternal database, OViewConfig cfg)
abstract OView	createView(ODatabaseDocumentInternal database, OViewConfig cfg, ViewCreationListener listener)
abstract OView	createView(ODatabaseDocumentInternal database, String viewName, String statement, Map<String,Object> metadata)
protected abstract OViewImpl	createViewInstance(String name)
abstract void	dropClass(ODatabaseDocumentInternal database, String className)
abstract void	dropView(ODatabaseDocumentInternal database, String viewName)
protected boolean	executeThroughDistributedStorage(ODatabaseDocumentInternal database)
boolean	existsClass(String iClassName)
boolean	existsView(String viewName)
protected OGlobalProperty	findOrCreateGlobalProperty(String name, OType type)
void	forceSnapshot(ODatabaseDocumentInternal database)
void	fromStream(ODocument document)	Binds ODocument to POJO.
Set<Integer>	getBlobClusters()
OClass	getClass(Class<?> iClass)
OClass	getClass(String iClassName)
OClass	getClassByClusterId(int clusterId)
Collection<OClass>	getClasses(ODatabaseDocumentInternal database)
Set<OClass>	getClassesRelyOnCluster(ODatabaseDocumentInternal database, String clusterName)
protected int	getClusterId(ODatabaseDocumentInternal database, String stringValue)
OClusterSelectionFactory	getClusterSelectionFactory()
List<OGlobalProperty>	getGlobalProperties()
OGlobalProperty	getGlobalPropertyById(int id)
ORID	getIdentity()
OClass	getOrCreateClass(ODatabaseDocumentInternal database, String iClassName)
OClass	getOrCreateClass(ODatabaseDocumentInternal database, String iClassName, OClass superClass)
abstract OClass	getOrCreateClass(ODatabaseDocumentInternal database, String iClassName, OClass... superClasses)
int	getVersion()
OView	getView(String viewName)
OView	getViewByClusterId(int clusterId)
Collection<OView>	getViews(ODatabaseDocumentInternal database)
Set<OView>	getViewsRelyOnCluster(ODatabaseDocumentInternal database, String clusterName)
OSchemaShared	load(ODatabaseDocumentInternal database)
OImmutableSchema	makeSnapshot(ODatabaseDocumentInternal database)
void	onPostIndexManagement()	Callback invoked when the schema is loaded, after all the initializations.
void	releaseSchemaReadLock()
void	releaseSchemaWriteLock(ODatabaseDocumentInternal database)
void	releaseSchemaWriteLock(ODatabaseDocumentInternal database, boolean iSave)
void	reload(ODatabaseDocumentInternal database)	Reloads the schema inside a storage's shared lock.
void	removeBlobCluster(ODatabaseDocumentInternal database, String clusterName)
void	sendCommand(ODatabaseDocumentInternal database, String command)
ODocument	toNetworkStream()
ODocument	toStream()	Binds POJO to ODocument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

classes

protected final Map<String,OClass> classes

clustersToClasses

protected final Map<Integer,OClass> clustersToClasses

views

protected final Map<String,OView> views

clustersToViews

protected final Map<Integer,OView> clustersToViews

snapshot

protected volatile OImmutableSchema snapshot

Constructor Details

OSchemaShared

public OSchemaShared()

Method Details

checkClassNameIfValid

public static Character checkClassNameIfValid(String iName)
                                       throws OSchemaException

Throws:

OSchemaException

checkFieldNameIfValid

public static Character checkFieldNameIfValid(String iName)

makeSnapshot

public OImmutableSchema makeSnapshot(ODatabaseDocumentInternal database)

forceSnapshot

public void forceSnapshot(ODatabaseDocumentInternal database)

getClusterSelectionFactory

public OClusterSelectionFactory getClusterSelectionFactory()

countClasses

public int countClasses(ODatabaseDocumentInternal database)

countViews

public int countViews(ODatabaseDocumentInternal database)

onPostIndexManagement

public void onPostIndexManagement()

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

createClass

public OClass createClass(ODatabaseDocumentInternal database,
 String className)

createClass

public OClass createClass(ODatabaseDocumentInternal database,
 String iClassName,
 OClass iSuperClass)

createClass

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

getOrCreateClass

public OClass getOrCreateClass(ODatabaseDocumentInternal database,
 String iClassName)

getOrCreateClass

public OClass getOrCreateClass(ODatabaseDocumentInternal database,
 String iClassName,
 OClass superClass)

getOrCreateClass

public abstract OClass getOrCreateClass(ODatabaseDocumentInternal database,
 String iClassName,
 OClass... superClasses)

createAbstractClass

public OClass createAbstractClass(ODatabaseDocumentInternal database,
 String className)

createAbstractClass

public OClass createAbstractClass(ODatabaseDocumentInternal database,
 String className,
 OClass superClass)

createAbstractClass

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

createClass

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

createClass

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

createClass

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

createView

public abstract OView createView(ODatabaseDocumentInternal database,
 String viewName,
 String statement,
 Map<String,Object> metadata)

createClassIfNotExists

public abstract boolean createClassIfNotExists(ODatabaseDocumentInternal session,
 String className)

createClassIfNotExists

public abstract boolean createClassIfNotExists(ODatabaseDocumentInternal session,
 String className,
 OClass... superclasses)

createView

public abstract OView createView(ODatabaseDocumentInternal database,
 OViewConfig cfg)

createView

public abstract OView createView(ODatabaseDocumentInternal database,
 OViewConfig cfg,
 ViewCreationListener listener)
                          throws UnsupportedOperationException

Throws:

UnsupportedOperationException

checkEmbedded

public abstract void checkEmbedded()

getClassByClusterId

public OClass getClassByClusterId(int clusterId)

getViewByClusterId

public OView getViewByClusterId(int clusterId)

dropClass

public abstract void dropClass(ODatabaseDocumentInternal database,
 String className)

dropView

public abstract void dropView(ODatabaseDocumentInternal database,
 String viewName)

reload

public void reload(ODatabaseDocumentInternal database)

Reloads the schema inside a storage's shared lock.

existsClass

public boolean existsClass(String iClassName)

existsView

public boolean existsView(String viewName)

getClass

public OClass getClass(Class<?> iClass)

getClass

public OClass getClass(String iClassName)

getView

public OView getView(String viewName)

acquireSchemaReadLock

public void acquireSchemaReadLock()

releaseSchemaReadLock

public void releaseSchemaReadLock()

acquireSchemaWriteLock

public void acquireSchemaWriteLock(ODatabaseDocumentInternal database)

releaseSchemaWriteLock

public void releaseSchemaWriteLock(ODatabaseDocumentInternal database)

releaseSchemaWriteLock

public void releaseSchemaWriteLock(ODatabaseDocumentInternal database,
 boolean iSave)

fromStream

public void fromStream(ODocument document)

Binds ODocument to POJO.

createClassInstance

protected abstract OClassImpl createClassInstance(String name)

createViewInstance

protected abstract OViewImpl createViewInstance(String name)

toNetworkStream

public ODocument toNetworkStream()

toStream

public ODocument toStream()

Binds POJO to ODocument.

getClasses

public Collection<OClass> getClasses(ODatabaseDocumentInternal database)

getViews

public Collection<OView> getViews(ODatabaseDocumentInternal database)

getClassesRelyOnCluster

public Set<OClass> getClassesRelyOnCluster(ODatabaseDocumentInternal database,
 String clusterName)

getViewsRelyOnCluster

public Set<OView> getViewsRelyOnCluster(ODatabaseDocumentInternal database,
 String clusterName)

load

public OSchemaShared load(ODatabaseDocumentInternal database)

create

public void create(ODatabaseDocumentInternal database)

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

public int getVersion()

getIdentity

public ORID getIdentity()

getGlobalPropertyById

public OGlobalProperty getGlobalPropertyById(int id)

createGlobalProperty

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

getGlobalProperties

public List<OGlobalProperty> getGlobalProperties()

findOrCreateGlobalProperty

protected OGlobalProperty findOrCreateGlobalProperty(String name,
 OType type)

executeThroughDistributedStorage

protected boolean executeThroughDistributedStorage(ODatabaseDocumentInternal database)

addClusterClassMap

protected void addClusterClassMap(OClass cls)

addClusterViewMap

protected void addClusterViewMap(OView cls)

addBlobCluster

public int addBlobCluster(ODatabaseDocumentInternal database,
 int clusterId)

removeBlobCluster

public void removeBlobCluster(ODatabaseDocumentInternal database,
 String clusterName)

getClusterId

protected int getClusterId(ODatabaseDocumentInternal database,
 String stringValue)

createClusterIfNeeded

public int createClusterIfNeeded(ODatabaseDocumentInternal database,
 String nameOrId)

getBlobClusters

public Set<Integer> getBlobClusters()

sendCommand

public void sendCommand(ODatabaseDocumentInternal database,
 String command)