OImmutableProperty (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.metadata.schema.OImmutableProperty

All Implemented Interfaces:

OProperty, Comparable<OProperty>
```
public class OImmutableProperty
extends Object
implements OProperty
```
Since:

10/21/14

Author:

Andrey Lomakin (a.lomakin-at-orientdb.com)

Nested Class Summary
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.metadata.schema.OProperty
  OProperty.ATTRIBUTES

Constructor Summary

Constructors
Constructor and Description

OImmutableProperty(OProperty property, OImmutableClass owner)

Constructors
Constructor and Description
`OImmutableProperty(OProperty property, OImmutableClass owner)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCustom()`
`int`	`compareTo(OProperty other)`
`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.
`OProperty`	`dropIndexes()` Remove the index on property
`boolean`	`equals(Object obj)`
`Object`	`get(OProperty.ATTRIBUTES attribute)`
`Collection<OIndex>`	`getAllIndexes()`
`OCollate`	`getCollate()`
`String`	`getCustom(String iName)`
`Set<String>`	`getCustomKeys()`
`String`	`getDefaultValue()` Default value for the property; can be function
`String`	`getDescription()`
`String`	`getFullName()` Returns the full name as .
`Integer`	`getId()`
`OIndex`	`getIndex()`
`Set<OIndex>`	`getIndexes()`
`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.
`Comparable<Object>`	`getMaxComparable()`
`String`	`getMin()` Min behavior depends on the Property OType.
`Comparable<Object>`	`getMinComparable()`
`String`	`getName()`
`OClass`	`getOwnerClass()`
`String`	`getRegexp()`
`OType`	`getType()`
`int`	`hashCode()`
`boolean`	`isIndexed()` Indicates whether property is contained in indexes as its first key item.
`boolean`	`isMandatory()`
`boolean`	`isNotNull()`
`boolean`	`isReadonly()`
`void`	`removeCustom(String iName)`
`void`	`set(OProperty.ATTRIBUTES attribute, Object iValue)`
`OProperty`	`setCollate(OCollate collate)`
`OProperty`	`setCollate(String iCollateName)`
`OProperty`	`setCustom(String iName, String iValue)`
`OProperty`	`setDefaultValue(String defaultValue)`
`OProperty`	`setDescription(String iDescription)`
`OProperty`	`setLinkedClass(OClass oClass)`
`OProperty`	`setLinkedType(OType type)`
`OProperty`	`setMandatory(boolean mandatory)`
`OProperty`	`setMax(String max)`
`OProperty`	`setMin(String min)`
`OProperty`	`setName(String iName)`
`OProperty`	`setNotNull(boolean iNotNull)`
`OProperty`	`setReadonly(boolean iReadonly)`
`OProperty`	`setRegexp(String regexp)`
`OProperty`	`setType(OType iType)` Change the type.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OImmutableProperty
```
public OImmutableProperty(OProperty property,
                          OImmutableClass owner)
```
- 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
  - setName
```
public OProperty setName(String iName)
```
    Specified by:
    
    setName in interface OProperty
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface OProperty
  - setDescription
```
public OProperty setDescription(String iDescription)
```
    Specified by:
    
    setDescription in interface OProperty
  - set
```
public void set(OProperty.ATTRIBUTES attribute,
                Object iValue)
```
    Specified by:
    
    set in interface OProperty
  - getType
```
public OType getType()
```
    Specified by:
    
    getType in interface OProperty
  - getLinkedClass
```
public OClass getLinkedClass()
```
    Description copied from interface: OProperty
    
    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 OProperty setLinkedClass(OClass oClass)
```
    Specified by:
    
    setLinkedClass in interface OProperty
  - getLinkedType
```
public OType getLinkedType()
```
    Specified by:
    
    getLinkedType in interface OProperty
  - setLinkedType
```
public OProperty setLinkedType(OType type)
```
    Specified by:
    
    setLinkedType in interface OProperty
  - isNotNull
```
public boolean isNotNull()
```
    Specified by:
    
    isNotNull in interface OProperty
  - setNotNull
```
public OProperty setNotNull(boolean iNotNull)
```
    Specified by:
    
    setNotNull in interface OProperty
  - getCollate
```
public OCollate getCollate()
```
    Specified by:
    
    getCollate in interface OProperty
  - setCollate
```
public OProperty setCollate(String iCollateName)
```
    Specified by:
    
    setCollate in interface OProperty
  - setCollate
```
public OProperty setCollate(OCollate collate)
```
    Specified by:
    
    setCollate in interface OProperty
  - isMandatory
```
public boolean isMandatory()
```
    Specified by:
    
    isMandatory in interface OProperty
  - setMandatory
```
public OProperty setMandatory(boolean mandatory)
```
    Specified by:
    
    setMandatory in interface OProperty
  - isReadonly
```
public boolean isReadonly()
```
    Specified by:
    
    isReadonly in interface OProperty
  - setReadonly
```
public OProperty setReadonly(boolean iReadonly)
```
    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 OProperty 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 OProperty 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 OProperty setDefaultValue(String defaultValue)
```
    Specified by:
    
    setDefaultValue in interface OProperty
    
    Parameters:
    
    defaultValue - can be null
    
    Returns:
    
    this property
    
    See Also:
    
    OProperty.getDefaultValue()
  - createIndex
```
public OIndex createIndex(OClass.INDEX_TYPE iType)
```
    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
    Returns:
    
    see OClass.createIndex(String, OClass.INDEX_TYPE, String...).
  - createIndex
```
public OIndex createIndex(String iType)
```
    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
    
    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...).
  - 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...).
  - dropIndexes
```
public OProperty dropIndexes()
```
    Description copied from interface: OProperty
    
    Remove the index on property
    
    Specified by:
    
    dropIndexes in interface OProperty
    
    Returns:
  - getIndexes
```
public Set<OIndex> getIndexes()
```
    Specified by:
    
    getIndexes in interface OProperty
    
    Returns:
    
    All indexes in which this property participates as first key item.
  - getIndex
```
public OIndex getIndex()
```
    Specified by:
    
    getIndex in interface OProperty
    
    Returns:
    
    The first index in which this property participates as first key item.
  - getAllIndexes
```
public Collection<OIndex> getAllIndexes()
```
    Specified by:
    
    getAllIndexes in interface OProperty
    
    Returns:
    
    All indexes in which this property participates.
  - isIndexed
```
public boolean isIndexed()
```
    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.
  - getRegexp
```
public String getRegexp()
```
    Specified by:
    
    getRegexp in interface OProperty
  - setRegexp
```
public OProperty setRegexp(String regexp)
```
    Specified by:
    
    setRegexp in interface OProperty
  - setType
```
public OProperty setType(OType iType)
```
    Description copied from interface: OProperty
    
    Change the type. It checks for compatibility between the change of type.
    
    Specified by:
    
    setType in interface OProperty
  - getCustom
```
public String getCustom(String iName)
```
    Specified by:
    
    getCustom in interface OProperty
  - setCustom
```
public OProperty setCustom(String iName,
                           String iValue)
```
    Specified by:
    
    setCustom in interface OProperty
  - 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
  - getOwnerClass
```
public OClass getOwnerClass()
```
    Specified by:
    
    getOwnerClass in interface OProperty
  - get
```
public Object get(OProperty.ATTRIBUTES attribute)
```
    Specified by:
    
    get in interface OProperty
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OProperty
  - compareTo
```
public int compareTo(OProperty other)
```
    Specified by:
    
    compareTo in interface Comparable<OProperty>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMaxComparable
```
public Comparable<Object> getMaxComparable()
```
  - getMinComparable
```
public Comparable<Object> getMinComparable()
```

Class OImmutableProperty

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OImmutableProperty

Method Detail

getName

getFullName

setName

getDescription

setDescription

set

getType

getLinkedClass

setLinkedClass

getLinkedType

setLinkedType

isNotNull

setNotNull

getCollate

setCollate

setCollate

isMandatory

setMandatory

isReadonly

setReadonly

getMin

setMin

getMax

setMax

getDefaultValue

setDefaultValue

createIndex

createIndex

createIndex

createIndex

dropIndexes

getIndexes

getIndex

getAllIndexes

isIndexed

getRegexp

setRegexp

setType

getCustom

setCustom

removeCustom

clearCustom

getCustomKeys

getOwnerClass

get

getId

compareTo

hashCode

equals

toString

getMaxComparable

getMinComparable