MemoryEntity (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.db.MemoryEntity

All Implemented Interfaces:

Entity, Remote
```
public class MemoryEntity
extends Object
implements Entity
```
Implements an entity that execute all operations in the machine memory. This class must no be used in remote way
Title:

Description:

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected Properties`	`alias`
`protected String`	`autonumericalColumn`
`protected Vector`	`columnNames`
`protected EntityResult`	`data`
`protected Vector`	`deleteKeys`
`protected Vector`	`descSortColumns`
`protected String`	`entityName`
`protected Vector`	`insertColumns`
`protected Vector`	`insertKeys`
`protected Vector`	`keys`
`protected EntityReferenceLocator`	`locator`
`protected Vector`	`otherEntities`
`protected int`	`privilegedId`
`protected int`	`queryOtherEntitiesLimit`
`protected Hashtable`	`reverseAlias`
`protected Vector`	`sortColumns`
`protected Vector`	`updateColumns`
`protected Vector`	`updateKeys`
`protected Vector`	`wildcardColumns`

Constructor Summary

Constructors
Constructor and Description

MemoryEntity(EntityReferenceLocator referenceLocator)

Constructors
Constructor and Description
`MemoryEntity(EntityReferenceLocator referenceLocator)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkDeleteKeys(Hashtable filterKeys)`
`void`	`checkInsertKeys(Hashtable attributesValues)`
`void`	`checkUpdateKeys(Hashtable filterKeys)`
`EntityResult`	`delete(Hashtable keys, int sessionId)` This method must implement a standard delete operation over the set of records defined by `keysValues`.
`String`	`getAliasForColumn(String columnName)`
`String`	`getColumnForAlias(String alias)`
`Vector`	`getValidAttributes(Vector attributes)`
`Hashtable`	`getValidDeletingKeysValues(Hashtable filterKeys)`
`Hashtable`	`getValidInsertingAttributesValues(Hashtable attributesValues)`
`Hashtable`	`getValidQueryingKeysValues(Hashtable filterKeys)`
`Hashtable`	`getValidUpdatingAttributesValues(Hashtable attributesValues)`
`Hashtable`	`getValidUpdatingKeysValues(Hashtable filterKeys)`
`EntityResult`	`insert(Hashtable attributes, int sessionId)` This method must implement a standard insert operation with the data contained in `attributesValues` parameter.
`protected void`	`loadAliasFile()` Read the alias property file.
`static Hashtable`	`processReferenceDataFieldAttributes(Hashtable kv)` Process the reference data field attributes ( `ReferenceFieldAttribute)`.
`static Vector`	`processReferenceDataFieldAttributes(Vector referenceDataFieldAttributes)` Process the ReferenceFieldAttribute objects.
`EntityResult`	`query(Hashtable keys, Vector attributes, int sessionId)` This method must implement a standard query operation returning the set of data that matches the conditions specified by the `keysValues` parameter.
`AdvancedEntityResult`	`query(Hashtable keys, Vector attributes, int startIndex, int number, String orderBy, int sessionId)`
`void`	`readProperties()` Reads the property file associated to the entity.
`protected void`	`readProperties(String path)`
`EntityResult`	`replaceAliasByColumn(EntityResult res)` This method replaces the name of the database columns with the correspondant alias, so that the result has the same names to those queried by the client.
`Hashtable`	`replaceAliasByColumn(Hashtable hash)`
`Vector`	`replaceAliasByColumn(Vector vect, Vector changedColumns)`
`EntityResult`	`replaceColumnByAlias(EntityResult res, Vector replacedColumnNames)`
`Hashtable`	`replaceColumnByAlias(Hashtable hash)`
`Vector`	`replaceColumnByAlias(Vector vect)`
`EntityResult`	`replaceColumnByAliasKeepColumns(EntityResult res)`
`EntityResult`	`update(Hashtable attributes, Hashtable keys, int sessionId)` This method must implement a standard update operation with the data specified in `attributesValues` over the set of records defined by `keysValues`.

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

- Field Detail
  - data
```
protected EntityResult data
```
  - columnNames
```
protected Vector columnNames
```
  - keys
```
protected Vector keys
```
  - insertKeys
```
protected Vector insertKeys
```
  - deleteKeys
```
protected Vector deleteKeys
```
  - updateKeys
```
protected Vector updateKeys
```
  - updateColumns
```
protected Vector updateColumns
```
  - autonumericalColumn
```
protected String autonumericalColumn
```
  - insertColumns
```
protected Vector insertColumns
```
  - wildcardColumns
```
protected Vector wildcardColumns
```
  - sortColumns
```
protected Vector sortColumns
```
  - descSortColumns
```
protected Vector descSortColumns
```
  - otherEntities
```
protected Vector otherEntities
```
  - locator
```
protected EntityReferenceLocator locator
```
  - queryOtherEntitiesLimit
```
protected int queryOtherEntitiesLimit
```
  - alias
```
protected Properties alias
```
  - reverseAlias
```
protected Hashtable reverseAlias
```
  - entityName
```
protected String entityName
```
  - privilegedId
```
protected int privilegedId
```
- Constructor Detail
  - MemoryEntity
```
public MemoryEntity(EntityReferenceLocator referenceLocator)
             throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - loadAliasFile
```
protected void loadAliasFile()
```
    Read the alias property file. This file has the same name as entity property file with the suffix '_alias'
  - readProperties
```
public void readProperties()
                    throws Exception
```
    Reads the property file associated to the entity. The name of the file must be the name of the class and it has to be located on a subfolder (relative to the class) called 'prop'.
    File format:
    Every name is a database column name, neither having alias or not.
    - 'Columns' key: Query columns. Each column name is separated by ;
    - 'InsertColumns' key: C Possible insert columns. If this parameter isn't specified, then 'Columns' value is used
    - 'Keys' key: entity keys
    - 'InsertKeys' key: c Valid and mandatory insert keys
    - 'DeleteKeys': Valid and mandatory delete keys
    - 'UpdateKeys' Valid and mandatory update keys
    - 'UpdateColumns" key: Possible update columns
    - 'OtherEntities' key: Specifies the names of the other entities that are going to be queried when querying this on. if the parameter isn't specified, then all entities are included.
    - 'LimitQueryOtherEntities' key: if there are multiple results for this entity, and other entity data is asked, then this entity will limit the number of records for which other entities are queried to this parameter. By default this value is 100
    
    Throws:
    
    Exception
  - readProperties
```
protected void readProperties(String path)
                       throws Exception
```
    Throws:
    
    Exception
  - processReferenceDataFieldAttributes
```
public static Hashtable processReferenceDataFieldAttributes(Hashtable kv)
```
    Process the reference data field attributes ( ReferenceFieldAttribute).
    This method is called for update and insert methods to know the name of the column associated to the ReferenceFieldAttribute
    
    Parameters:
    kv -
    
    Returns:
    This object is similar to kv paramer, but the keys of ReferenceFielAttribute type are replaced by ReferenceFieldAttribute.getAttr()
  - checkInsertKeys
```
public void checkInsertKeys(Hashtable attributesValues)
                     throws Exception
```
    Throws:
    
    Exception
  - checkUpdateKeys
```
public void checkUpdateKeys(Hashtable filterKeys)
                     throws Exception
```
    Throws:
    
    Exception
  - checkDeleteKeys
```
public void checkDeleteKeys(Hashtable filterKeys)
                     throws Exception
```
    Throws:
    
    Exception
  - getAliasForColumn
```
public String getAliasForColumn(String columnName)
```
  - getColumnForAlias
```
public String getColumnForAlias(String alias)
```
  - replaceAliasByColumn
```
public Hashtable replaceAliasByColumn(Hashtable hash)
```
  - replaceColumnByAlias
```
public Hashtable replaceColumnByAlias(Hashtable hash)
```
  - replaceAliasByColumn
```
public EntityResult replaceAliasByColumn(EntityResult res)
```
    This method replaces the name of the database columns with the correspondant alias, so that the result has the same names to those queried by the client.
    I.e. the client asks for the alias and, if possible, must receive alias..
    
    Parameters:
    res -
    
    Returns:
  - replaceColumnByAlias
```
public EntityResult replaceColumnByAlias(EntityResult res,
                                Vector replacedColumnNames)
```
  - replaceColumnByAliasKeepColumns
```
public EntityResult replaceColumnByAliasKeepColumns(EntityResult res)
```
  - replaceAliasByColumn
```
public Vector replaceAliasByColumn(Vector vect,
                          Vector changedColumns)
```
  - replaceColumnByAlias
```
public Vector replaceColumnByAlias(Vector vect)
```
  - getValidAttributes
```
public Vector getValidAttributes(Vector attributes)
```
  - getValidQueryingKeysValues
```
public Hashtable getValidQueryingKeysValues(Hashtable filterKeys)
```
  - getValidInsertingAttributesValues
```
public Hashtable getValidInsertingAttributesValues(Hashtable attributesValues)
```
  - getValidUpdatingAttributesValues
```
public Hashtable getValidUpdatingAttributesValues(Hashtable attributesValues)
```
  - getValidUpdatingKeysValues
```
public Hashtable getValidUpdatingKeysValues(Hashtable filterKeys)
```
  - getValidDeletingKeysValues
```
public Hashtable getValidDeletingKeysValues(Hashtable filterKeys)
```
  - processReferenceDataFieldAttributes
```
public static Vector processReferenceDataFieldAttributes(Vector referenceDataFieldAttributes)
```
    Process the ReferenceFieldAttribute objects. Creates a vector equals to the entry parameter and add to it the ReferenceFieldAttribute.getAttr() for all object of ReferenceFieldAttribute type.
    
    Parameters:
    referenceDataFieldAttributes -
    
    Returns:
  - query
```
public AdvancedEntityResult query(Hashtable keys,
                         Vector attributes,
                         int startIndex,
                         int number,
                         String orderBy,
                         int sessionId)
                           throws Exception
```
    Throws:
    
    Exception
  - query
```
public EntityResult query(Hashtable keys,
                 Vector attributes,
                 int sessionId)
                   throws Exception
```
    Description copied from interface: Entity
    
    This method must implement a standard query operation returning the set of data that matches the conditions specified by the keysValues parameter. The attributes defines which attributes (or columns if data is obtained from a database) must be recovered, and keysValues specifies which set of records must be recovered.
    
    Specified by:
    
    query in interface Entity
    
    Parameters:
    keys - a Hashtable specifying conditions that must comply the set of records returned. Cannot be null.
    attributes - a list of columns or attributes that must be recovered for each record returned. Cannot be null. If empty, all attributes should be returned.
    sessionId - a integer identifying the user or session that performs the action.
    
    Returns:
    a EntityResult with the resulting set of data. This result can be empty if no results exist, and if an error has ocurred this will be indicated in the result.
    
    Throws:
    
    Exception - if any exception occurs
  - insert
```
public EntityResult insert(Hashtable attributes,
                  int sessionId)
                    throws Exception
```
    Description copied from interface: Entity
    
    This method must implement a standard insert operation with the data contained in attributesValues parameter.
    
    Specified by:
    
    insert in interface Entity
    
    Parameters:
    attributes - a Hashtable specifying pairs of key-value corresponding to the attribute (or column of a table in a database) and the value that must be stored.
    sessionId - a integer identifying the user or session that performs the action.
    
    Returns:
    a EntityResult. This result will have an error code if error has ocurred.
    
    Throws:
    
    Exception - if any exception occurs
  - update
```
public EntityResult update(Hashtable attributes,
                  Hashtable keys,
                  int sessionId)
                    throws Exception
```
    Description copied from interface: Entity
    
    This method must implement a standard update operation with the data specified in attributesValues over the set of records defined by keysValues. So, only the records that comply with the conditions specified by keysValues will be updated to the new values specified by attributesValues.
    
    Specified by:
    
    update in interface Entity
    
    Parameters:
    attributes - the data for updating the records to. The keys specify the attributes (or columns) and the values, the values for these columns.
    keys - the conditions that the records to be updated must fulfill. The keys specify the attributes (or columns) and the values, the values for these columns.
    sessionId - a integer identifying the user or session that performs the action.
    
    Returns:
    a EntityResult. This result will have an error code if error has occurred.
    
    Throws:
    
    Exception - if any exception occurs
  - delete
```
public EntityResult delete(Hashtable keys,
                  int sessionId)
                    throws Exception
```
    Description copied from interface: Entity
    
    This method must implement a standard delete operation over the set of records defined by keysValues. So, only the records that comply with the conditions specified by keysValues will be deleted.
    
    Specified by:
    
    delete in interface Entity
    
    Parameters:
    keys - the conditions that the records to be deleted must fulfill. The keys specify the attributes (or columns) and the values, the values for these columns.
    sessionId - a integer identifying the user or session that performs the action.
    
    Returns:
    a EntityResult. This result will have an error code if error has occurred.
    
    Throws:
    
    Exception - if any exception occurs

Class MemoryEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

columnNames

keys

insertKeys

deleteKeys

updateKeys

updateColumns

autonumericalColumn

insertColumns

wildcardColumns

sortColumns

descSortColumns

otherEntities

locator

queryOtherEntitiesLimit

alias

reverseAlias

entityName

privilegedId

Constructor Detail

MemoryEntity

Method Detail

loadAliasFile

readProperties

readProperties

processReferenceDataFieldAttributes

checkInsertKeys

checkUpdateKeys

checkDeleteKeys

getAliasForColumn

getColumnForAlias

replaceAliasByColumn

replaceColumnByAlias

replaceAliasByColumn

replaceColumnByAlias

replaceColumnByAliasKeepColumns

replaceAliasByColumn

replaceColumnByAlias

getValidAttributes

getValidQueryingKeysValues

getValidInsertingAttributesValues

getValidUpdatingAttributesValues

getValidUpdatingKeysValues

getValidDeletingKeysValues

processReferenceDataFieldAttributes

query

query

insert

update

delete