com.orientechnologies.orient.core.metadata.schema

Class OPropertyImpl

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

com.orientechnologies.orient.core.metadata.schema.OPropertyImpl

All Implemented Interfaces:

OProperty, Serializable, Comparable<OProperty>

public class OPropertyImpl
extends ODocumentWrapperNoClass
implements OProperty

Contains the description of a persistent class property.

Author:

Luca Garulli

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.metadata.schema.OProperty

OProperty.ATTRIBUTES

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
OPropertyImpl(OClassImpl oClassImpl, OGlobalProperty global)

Method Summary

Modifier and Type	Method and Description
void	acquireSchemaReadLock()
void	acquireSchemaWriteLock()
void	checkEmbedded()
protected static void	checkLinkTypeSupport(OType type)
protected static void	checkSupportLinkedClass(OType type)
void	clearCustom()
int	compareTo(OProperty o)
OIndex<?>	createIndex(OClass.INDEX_TYPE iType) Creates an index on this property.
OIndex<?>	createIndex(OClass.INDEX_TYPE iType, ODocument metadata) Creates an index on this property.
OIndex<?>	createIndex(String iType) Creates an index on this property.
OIndex<?>	createIndex(String iType, ODocument metadata) Creates an index on this property.
OPropertyImpl	dropIndexes() Deprecated. Use OIndexManager.dropIndex(String) instead.
void	dropIndexesInternal() Deprecated. by dropIndexes()
boolean	equals(Object obj)
void	fromStream()
Object	get(OProperty.ATTRIBUTES attribute)
Collection<OIndex<?>>	getAllIndexes()
OCollate	getCollate()
String	getCustom(String iName)
Map<String,String>	getCustomInternal()
Set<String>	getCustomKeys()
protected ODatabaseDocumentInternal	getDatabase()
String	getDefaultValue() Default value for the property; can be function
String	getDescription()
String	getFullName() Returns the full name as .
String	getFullNameQuoted()
Integer	getId()
OIndex<?>	getIndex() Deprecated. Use OClass.getInvolvedIndexes(String...) instead.
Set<OIndex<?>>	getIndexes() Deprecated. Use OClass.getInvolvedIndexes(String...) instead.
OClass	getLinkedClass() Returns the linked class in lazy mode because while unmarshalling the class could be not loaded yet.
OType	getLinkedType()
String	getMax() Max behavior depends on the Property OType.
String	getMin() Min behavior depends on the Property OType.
String	getName()
OClass	getOwnerClass()
String	getRegexp()
OType	getType()
int	hashCode()
boolean	isIndexed() Deprecated. Use OClass.areIndexed(String...) instead.
boolean	isMandatory()
boolean	isNotNull()
boolean	isReadonly()
void	releaseSchemaReadLock()
void	releaseSchemaWriteLock()
void	removeCustom(String iName)
void	set(OProperty.ATTRIBUTES attribute, Object iValue)
OProperty	setCollate(OCollate collate)
OProperty	setCollate(String collate)
OPropertyImpl	setCustom(String name, String value)
OPropertyImpl	setDefaultValue(String defaultValue)
OPropertyImpl	setDescription(String iDescription)
OPropertyImpl	setLinkedClass(OClass linkedClass)
OProperty	setLinkedType(OType linkedType)
OPropertyImpl	setMandatory(boolean isMandatory)
OPropertyImpl	setMax(String max)
OPropertyImpl	setMin(String min)
OProperty	setName(String name)
OPropertyImpl	setNotNull(boolean isNotNull)
OPropertyImpl	setReadonly(boolean isReadonly)
OPropertyImpl	setRegexp(String regexp)
OPropertyImpl	setType(OType type) Change the type.
ODocument	toStream()
String	toString()

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

fromStream, load, load, reload, reload, save, save

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

getDocument, load, load, reload

Methods inherited from class java.lang.Object

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

Constructor Detail

OPropertyImpl

public OPropertyImpl(OClassImpl oClassImpl,
                     OGlobalProperty global)

Method Detail

getName

public String getName()

Specified by:

getName in interface OProperty

getFullName

public String getFullName()

Description copied from interface: OProperty

Returns the full name as .

Specified by:

getFullName in interface OProperty

getFullNameQuoted

public String getFullNameQuoted()

getType

public OType getType()

Specified by:

getType in interface OProperty

setType

public OPropertyImpl setType(OType type)

Description copied from interface: OProperty

Change the type. It checks for compatibility between the change of type.

Specified by:

setType in interface OProperty

compareTo

public int compareTo(OProperty o)

Specified by:

compareTo in interface Comparable<OProperty>

createIndex

public OIndex<?> createIndex(OClass.INDEX_TYPE iType)

Creates an index on this property. Indexes speed up queries but slow down insert and update operations. For massive inserts we suggest to remove the index, make the massive insert and recreate it.

Specified by:

createIndex in interface OProperty

Parameters:

iType - One of types supported.

• UNIQUE: Doesn't allow duplicates
• NOTUNIQUE: Allow duplicates
• FULLTEXT: Indexes single word for full text search

Returns:

See Also:

OClass#createIndex(String, OClass.INDEX_TYPE, String...)} instead.

createIndex

public OIndex<?> createIndex(String iType)

Creates an index on this property. Indexes speed up queries but slow down insert and update operations. For massive inserts we suggest to remove the index, make the massive insert and recreate it.

Specified by:

createIndex in interface OProperty

Parameters:

iType -

Returns:

See Also:

OClass#createIndex(String, OClass.INDEX_TYPE, String...)} instead.

createIndex

public OIndex<?> createIndex(OClass.INDEX_TYPE iType,
                             ODocument metadata)

Description copied from interface: OProperty

Creates an index on this property. Indexes speed up queries but slow down insert and update operations. For massive inserts we suggest to remove the index, make the massive insert and recreate it.

Specified by:

createIndex in interface OProperty

Parameters:

iType - One of types supported.

• UNIQUE: Doesn't allow duplicates
• NOTUNIQUE: Allow duplicates
• FULLTEXT: Indexes single word for full text search

metadata - the index metadata

Returns:

see OClass.createIndex(String, OClass.INDEX_TYPE, String...).

createIndex

public OIndex<?> createIndex(String iType,
                             ODocument metadata)

Description copied from interface: OProperty

Creates an index on this property. Indexes speed up queries but slow down insert and update operations. For massive inserts we suggest to remove the index, make the massive insert and recreate it.

Specified by:

createIndex in interface OProperty

Parameters:

iType - One of types supported.

• UNIQUE: Doesn't allow duplicates
• NOTUNIQUE: Allow duplicates
• FULLTEXT: Indexes single word for full text search

metadata - the index metadata

Returns:

see OClass.createIndex(String, OClass.INDEX_TYPE, String...).

dropIndexes

@Deprecated
public OPropertyImpl dropIndexes()

Deprecated. Use OIndexManager.dropIndex(String) instead.

Remove the index on property

Specified by:

dropIndexes in interface OProperty

Returns:

dropIndexesInternal

@Deprecated
public void dropIndexesInternal()

Deprecated. by dropIndexes()

Remove the index on property

getIndex

@Deprecated
public OIndex<?> getIndex()

Deprecated. Use OClass.getInvolvedIndexes(String...) instead.

Returns the first index defined for the property.

Specified by:

getIndex in interface OProperty

Returns:

The first index in which this property participates as first key item.

getIndexes

@Deprecated
public Set<OIndex<?>> getIndexes()

Deprecated. Use OClass.getInvolvedIndexes(String...) instead.

Specified by:

getIndexes in interface OProperty

Returns:

All indexes in which this property participates as first key item.

isIndexed

@Deprecated
public boolean isIndexed()

Deprecated. Use OClass.areIndexed(String...) instead.

Description copied from interface: OProperty

Indicates whether property is contained in indexes as its first key item. If you would like to fetch all indexes or check property presence in other indexes use OProperty.getAllIndexes() instead.

Specified by:

isIndexed in interface OProperty

Returns:

true if and only if this property is contained in indexes as its first key item.

getOwnerClass

public OClass getOwnerClass()

Specified by:

getOwnerClass in interface OProperty

setName

public OProperty setName(String name)

Specified by:

setName in interface OProperty

getLinkedClass

public OClass getLinkedClass()

Returns the linked class in lazy mode because while unmarshalling the class could be not loaded yet.

Specified by:

getLinkedClass in interface OProperty

Returns:

setLinkedClass

public OPropertyImpl setLinkedClass(OClass linkedClass)

Specified by:

setLinkedClass in interface OProperty

checkSupportLinkedClass

protected static void checkSupportLinkedClass(OType type)

getLinkedType

public OType getLinkedType()

Specified by:

getLinkedType in interface OProperty

setLinkedType

public OProperty setLinkedType(OType linkedType)

Specified by:

setLinkedType in interface OProperty

checkLinkTypeSupport

protected static void checkLinkTypeSupport(OType type)

isNotNull

public boolean isNotNull()

Specified by:

isNotNull in interface OProperty

setNotNull

public OPropertyImpl setNotNull(boolean isNotNull)

Specified by:

setNotNull in interface OProperty

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface OProperty

setMandatory

public OPropertyImpl setMandatory(boolean isMandatory)

Specified by:

setMandatory in interface OProperty

isReadonly

public boolean isReadonly()

Specified by:

isReadonly in interface OProperty

setReadonly

public OPropertyImpl setReadonly(boolean isReadonly)

Specified by:

setReadonly in interface OProperty

getMin

public String getMin()

Description copied from interface: OProperty

Min behavior depends on the Property OType.

• String : minimum length
• Number : minimum value
• date and time : minimum time in millisecond, date must be written in the storage date format
• binary : minimum size of the byte array
• List,Set,Collection : minimum size of the collection

Specified by:

getMin in interface OProperty

Returns:

String, can be null

setMin

public OPropertyImpl setMin(String min)

Specified by:

setMin in interface OProperty

Parameters:

min - can be null

Returns:

this property

See Also:

OProperty.getMin()

getMax

public String getMax()

Description copied from interface: OProperty

Max behavior depends on the Property OType.

• String : maximum length
• Number : maximum value
• date and time : maximum time in millisecond, date must be written in the storage date format
• binary : maximum size of the byte array
• List,Set,Collection : maximum size of the collection

Specified by:

getMax in interface OProperty

Returns:

String, can be null

setMax

public OPropertyImpl setMax(String max)

Specified by:

setMax in interface OProperty

Parameters:

max - can be null

Returns:

this property

See Also:

OProperty.getMax()

getDefaultValue

public String getDefaultValue()

Description copied from interface: OProperty

Default value for the property; can be function

Specified by:

getDefaultValue in interface OProperty

Returns:

String, can be null

setDefaultValue

public OPropertyImpl setDefaultValue(String defaultValue)

Specified by:

setDefaultValue in interface OProperty

Parameters:

defaultValue - can be null

Returns:

this property

See Also:

OProperty.getDefaultValue()

getRegexp

public String getRegexp()

Specified by:

getRegexp in interface OProperty

setRegexp

public OPropertyImpl setRegexp(String regexp)

Specified by:

setRegexp in interface OProperty

getCustom

public String getCustom(String iName)

Specified by:

getCustom in interface OProperty

setCustom

public OPropertyImpl setCustom(String name,
                               String value)

Specified by:

setCustom in interface OProperty

getCustomInternal

public Map<String,String> getCustomInternal()

removeCustom

public void removeCustom(String iName)

Specified by:

removeCustom in interface OProperty

clearCustom

public void clearCustom()

Specified by:

clearCustom in interface OProperty

getCustomKeys

public Set<String> getCustomKeys()

Specified by:

getCustomKeys in interface OProperty

get

public Object get(OProperty.ATTRIBUTES attribute)

Specified by:

get in interface OProperty

set

public void set(OProperty.ATTRIBUTES attribute,
                Object iValue)

Specified by:

set in interface OProperty

getCollate

public OCollate getCollate()

Specified by:

getCollate in interface OProperty

setCollate

public OProperty setCollate(OCollate collate)

Specified by:

setCollate in interface OProperty

setCollate

public OProperty setCollate(String collate)

Specified by:

setCollate in interface OProperty

getDescription

public String getDescription()

Specified by:

getDescription in interface OProperty

setDescription

public OPropertyImpl setDescription(String iDescription)

Specified by:

setDescription in interface OProperty

toString

public String toString()

Overrides:

toString in class ODocumentWrapper

hashCode

public int hashCode()

Overrides:

hashCode in class ODocumentWrapper

equals

public boolean equals(Object obj)

Overrides:

equals in class ODocumentWrapper

fromStream

public void fromStream()

Specified by:

fromStream in class ODocumentWrapperNoClass

getAllIndexes

public Collection<OIndex<?>> getAllIndexes()

Specified by:

getAllIndexes in interface OProperty

Returns:

All indexes in which this property participates.

toStream

@OBeforeSerialization
public ODocument toStream()

Overrides:

toStream in class ODocumentWrapper

acquireSchemaReadLock

public void acquireSchemaReadLock()

releaseSchemaReadLock

public void releaseSchemaReadLock()

acquireSchemaWriteLock

public void acquireSchemaWriteLock()

releaseSchemaWriteLock

public void releaseSchemaWriteLock()

checkEmbedded

public void checkEmbedded()

getDatabase

protected ODatabaseDocumentInternal getDatabase()

getId

public Integer getId()

Specified by:

getId in interface OProperty