|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class defines methods to access entity information as well as to:
In this class, all methods related sub-entities all throw DKUsageError indicating that the default datastores does not support sub-entities. However, if the datastore support this kind of multi-level entities, for example, QBIC datastore, the sub-class for these datastore need to implement these methods to overwrite the exceptions.
Method Summary | |
void |
add()
Adds this entity definition to the persistent store, i.e. |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity in the persistent store. |
void |
add(dkEntityDef subEntityObj)
Adds the sub entity definition object to the this entity in the persistent store. |
void |
addAttr(dkAttrDef attrObj)
Adds the given attribute definition object to the this entity. |
void |
addSubEntity(dkEntityDef subEntityObj)
Adds the sub entity definition object to the this entity in memory. |
void |
clearCache()
Clear entity def cache |
dkAttrDef |
createAttr()
Creates new dkAttrDef and returns it to caller. |
dkEntityDef |
createSubEntity()
Creates new dkEntityDef and returns it to caller. |
java.lang.String |
datastoreName()
Gets the name of this datastore object. |
java.lang.String |
datastoreType()
Gets the type for this datastore object |
void |
del()
Deletes this entity from the persistent store, e.g. |
void |
del(dkAttrDef attrObj)
Deletes the given attribute from this entity in the persistent store. |
void |
del(dkEntityDef subEntityObj)
Delete the sub entity definition object from this entity in the persistent store. |
void |
deleteAttr(java.lang.String attrName)
Deletes the given attribute from this entity in the persistent store. |
void |
deleteSubEntity(java.lang.String subEntityName)
Delete the sub entity definition object from this entity in the persistent store. |
dkAttrDef |
getAttr(java.lang.String attrName)
Gets an attribute object from a given attribute name (memory-only) |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object |
java.lang.String |
getDescription()
Get the description of this entity |
java.lang.String |
getName()
Gets entity name |
java.lang.String |
getParentEntityName()
Gets the parent entity name |
dkEntityDef |
getSubEntity(java.lang.String subEntityName)
Gets a sub entity object from a given sub entity name. |
short |
getType()
Gets type of this entity |
boolean |
hasSubEntities()
Checks if this entity has sub entity objects |
boolean |
isSearchable()
Checks if the entity is searchable |
boolean |
isTextSearchable()
Checks if this entity is text searchable |
java.lang.String[] |
listAttrNames()
Gets a list of attributes |
dkCollection |
listAttrs()
Gets a list of attributes |
dkCollection |
listSubEntities()
Gets a list of sub entities |
java.lang.String[] |
listSubEntityNames()
Gets a list of sub entity names |
void |
removeAttr(java.lang.String attrName)
Removes the given attribute from this entity. |
void |
removeSubEntity(java.lang.String subEntityName)
Removes the sub entity definition object from this entity in memory. |
dkAttrDef |
retrieveAttr(java.lang.String attrName)
Retrieves an attribute object from a given attribute name from the persistent datastore. |
dkEntityDef |
retrieveSubEntity(java.lang.String subEntityName)
Retrieves a sub entity object from a given sub entity name from the persistent datastore. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object |
void |
setDescription(java.lang.String desc)
Sets description of this entity |
void |
setName(java.lang.String name)
Sets entity name |
void |
setParentEntityName(java.lang.String parentEntityName)
Sets the parent entity name |
void |
setTextSearchable(boolean isTextSearchable)
Sets this entity to be text searchable |
void |
setType(short entityType)
Sets type of this entity |
Method Detail |
public void setDatastore(dkDatastore ds)
ds
- datastorepublic dkDatastore getDatastore()
public java.lang.String datastoreName() throws java.lang.Exception
public java.lang.String datastoreType() throws java.lang.Exception
public java.lang.String getName()
public void setName(java.lang.String name)
name
- new name to be set to this entity objectpublic short getType()
public void setType(short entityType)
entityType
- entity typepublic java.lang.String getDescription()
public void setDescription(java.lang.String desc)
desc
- description about this entitypublic boolean isSearchable() throws DKException, java.lang.Exception
public boolean hasSubEntities() throws DKException, java.lang.Exception
public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public java.lang.String getParentEntityName()
public void setParentEntityName(java.lang.String parentEntityName)
parentEntityName
- parent entity name.public dkEntityDef getSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityName
- name of sub entity to getDKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public dkEntityDef retrieveSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityName
- name of entity to be retrievedDKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public dkCollection listSubEntities() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public java.lang.String[] listSubEntityNames() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if the datastore does not support multi-level
entity, i.e. this entity object does not have sub-entities.public void add(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityObj
- an sub entity object to be added to this
entity objectDKException
- if there is error in datastore serverpublic void del(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityObj
- an sub entity object to be deleted from this
entity objectDKException
- if the error occurs in datastorepublic void deleteSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityName
- an sub entity object to be deleted from this
entity objectDKException
- if the error occurs in datastorepublic void addSubEntity(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityObj
- an sub entity object to be added to this
entity objectDKException
- if there is error in datastore serverpublic void removeSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
subEntityName
- an sub entity object to be removed from this
entity objectDKException
- if the error occurs in datastorepublic dkAttrDef createAttr() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if this entity does not have attributepublic dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrName
- name of attribute to be retrievedDKException
- if the attribute name is not existpublic dkAttrDef retrieveAttr(java.lang.String attrName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrName
- name of attribute to be retrievedDKException
- if the attribute name is not existpublic dkCollection listAttrs() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- when the subclass does not
implement this methodpublic void del() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- when the subclass does not implement this methodpublic void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrObj
- an attribute object to be added to this entity objectDKException
- if there is error in datastore serverpublic void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrObj
- an attribute object to be deleted from this entity objectDKException
- if the error occurs in datastorepublic void deleteAttr(java.lang.String attrName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrName
- an attribute name to be deleted from this entity objectDKException
- if the error occurs in datastorepublic void addAttr(dkAttrDef attrObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrObj
- an attribute object to be added to this entity objectDKException
- if there is error in datastore serverpublic void removeAttr(java.lang.String attrName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
attrName
- an attribute name to be removed from this entity objectDKException
- if the error occurs in datastorepublic boolean isTextSearchable()
public void setTextSearchable(boolean isTextSearchable) throws DKException, java.lang.Exception
textSearchable
- is true if the entity is text searchablepublic void clearCache() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |