org.modelsphere.sms.or.db
Class DbORIndexKey

java.lang.Object
  extended by PersistentObject
      extended by org.modelsphere.jack.baseDb.db.DbObject
          extended by org.modelsphere.sms.db.DbSMSIndexKey
              extended by org.modelsphere.sms.or.db.DbORIndexKey

public final class DbORIndexKey
extends DbSMSIndexKey

Direct subclass(es)/subinterface(s) : none.
Composites : DbORIndex.
Components : none.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.modelsphere.jack.baseDb.db.DbObject
DbObject.ComponentIterator
 
Field Summary
static MetaField fExpression
           
static MetaRelation1 fIndexedElement
           
static MetaField fSortOption
           
static MetaClass metaClass
           
 
Fields inherited from class org.modelsphere.jack.baseDb.db.DbObject
ACCESS_GRANTED, ACCESS_NOT_GRANTED, fComponents, fComposite, fCreationTime, fModificationTime, fUdfValues, fValidationStatus, LONG_FORM, SHORT_FORM, VALIDATION_ERROR, VALIDATION_OK, VALIDATION_WARNING, writeAccess
 
Constructor Summary
DbORIndexKey()
          Parameter-less constructor.
DbORIndexKey(DbObject composite)
          Creates an instance of DbORIndexKey.
 
Method Summary
 java.lang.String getExpression()
          Gets the "expression" property of a DbORIndexKey's instance.
 DbORColumn getIndexedElement()
          Gets the column object associated to a DbORIndexKey's instance.
 MetaClass getMetaClass()
           
 java.lang.String getName()
           
 java.lang.String getSemanticalName(int form)
           
 ORIndexKeySort getSortOption()
          Gets the "sort" of a DbORIndexKey's instance.
static void initMeta()
          For internal use only.
 void set(MetaField metaField, java.lang.Object value)
           
 void set(MetaRelationN relation, DbObject neighbor, int op)
           
 void setExpression(java.lang.String value)
          Sets the "expression" property of a DbORIndexKey's instance.
 void setIndexedElement(DbORColumn value)
          Sets the column object associated to a DbORIndexKey's instance.
 void setSortOption(ORIndexKeySort value)
          Sets the "sort" property of a DbORIndexKey's instance.
 
Methods inherited from class org.modelsphere.jack.baseDb.db.DbObject
addDbRefreshListener, addDbRefreshListener, basicReinsert, basicSet, basicSet, buildFullNameString, buildFullNameString, componentTree, componentTree, componentTree, copyComponent, createComponent, createComponent, createRAMRelN, deepCopy, deepCopy, doDeleteAction, findComponentByName, findComponentByName, findMatchingObject, generateEDCTimestamp, get, get, get, getAccordingToStatus, getComponents, getComposite, getCompositeOfType, getCreationTime, getDb, getDependencyRelations, getEDCTimestamp, getFullDisplayName, getId, getMatchingObject, getMinCard, getModificationTime, getNbNeighbors, getNextTs, getOld, getProject, getSemanticalIcon, getTransStatus, getTs, getUDF, getUdfValues, getValidationStatus, hasAdminAccess, hasChanged, hasField, hasWriteAccess, isAddedAndRemoved, isAlive, isDeletable, isDescendingFrom, isHugeRelN, load, load, matches, reinsert, remove, removeDbRefreshListener, save, set, setComposite, setMatchingObject, setModificationTime, setName, setRelationNN, setRelationNN, setValidationStatus, toString, valuesAreEqual
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fIndexedElement

public static final MetaRelation1 fIndexedElement

fExpression

public static final MetaField fExpression

fSortOption

public static final MetaField fSortOption

metaClass

public static final MetaClass metaClass
Constructor Detail

DbORIndexKey

public DbORIndexKey()
Parameter-less constructor. Required by Java Beans Conventions.


DbORIndexKey

public DbORIndexKey(DbObject composite)
             throws DbException
Creates an instance of DbORIndexKey.

Parameters:
composite - the object which will contain the newly-created instance
Throws:
DbException
Method Detail

initMeta

public static void initMeta()
For internal use only.


getSemanticalName

public final java.lang.String getSemanticalName(int form)
                                         throws DbException
Overrides:
getSemanticalName in class DbObject
Parameters:
form - int
Returns:
string
Throws:
DbException

getName

public final java.lang.String getName()
                               throws DbException
Overrides:
getName in class DbObject
Returns:
string
Throws:
DbException

setIndexedElement

public final void setIndexedElement(DbORColumn value)
                             throws DbException
Sets the column object associated to a DbORIndexKey's instance.

Parameters:
value - the column object to be associated
Throws:
DbException

setExpression

public final void setExpression(java.lang.String value)
                         throws DbException
Sets the "expression" property of a DbORIndexKey's instance.

Parameters:
value - the "expression" property
Throws:
DbException

setSortOption

public final void setSortOption(ORIndexKeySort value)
                         throws DbException
Sets the "sort" property of a DbORIndexKey's instance.

Parameters:
value - the "sort" property
Throws:
DbException

set

public void set(MetaField metaField,
                java.lang.Object value)
         throws DbException
Overrides:
set in class DbSMSIndexKey
Throws:
DbException

set

public void set(MetaRelationN relation,
                DbObject neighbor,
                int op)
         throws DbException
Overrides:
set in class DbSMSIndexKey
Throws:
DbException

getIndexedElement

public final DbORColumn getIndexedElement()
                                   throws DbException
Gets the column object associated to a DbORIndexKey's instance.

Returns:
the column object
Throws:
DbException

getExpression

public final java.lang.String getExpression()
                                     throws DbException
Gets the "expression" property of a DbORIndexKey's instance.

Returns:
the "expression" property
Throws:
DbException

getSortOption

public final ORIndexKeySort getSortOption()
                                   throws DbException
Gets the "sort" of a DbORIndexKey's instance.

Returns:
the "sort"
Throws:
DbException

getMetaClass

public MetaClass getMetaClass()
Specified by:
getMetaClass in class DbObject


Open ModelSphere 2007. All Rights Reserved.