|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.cnri.do_api.EntityMap
public class EntityMap
An EntityMap stores a mapping from identifiers to local, human readable names.
Nested Class Summary | |
---|---|
class |
EntityMap.Entity
|
Field Summary | |
---|---|
static java.lang.String |
ADDRESS_BOOK_ELEMENT_ID
|
static java.lang.String |
ENTITY_LIST
|
static java.lang.String |
ID_ATTRIBUTE
|
static java.lang.String |
NAME_ATTRIBUTE
|
static java.lang.String |
TYPE_ATTRIBUTE
|
Constructor Summary | |
---|---|
EntityMap()
|
Method Summary | |
---|---|
void |
addEntity(EntityMap.Entity newEntity)
|
java.util.List |
getEntities()
Return a java.util.List containing the EntityMap.Entity objects in the list. |
EntityMap.Entity |
getEntity(int entityIndex)
Return the address book entity at the given index |
EntityMap.Entity |
getEntityForID(java.lang.String entityID)
Return the entity with the given ID or null if no entity has that ID. |
java.lang.String |
getEntityLabel(java.lang.String entityID)
Return a label that can be used to describe the entity having the given ID. |
java.lang.String |
getEntityName(java.lang.String entityID,
java.lang.String defaultVal)
Return the name that is associated with the given ID. |
int |
getNumEntities()
Get the number of known entities in the mapping/list |
void |
loadFromObject(DigitalObject obj)
Load the entity map from the given DigitalObject |
void |
removeEntity(EntityMap.Entity entityToRemove)
Remove the given entity from the list |
void |
saveToObject(DigitalObject obj)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ADDRESS_BOOK_ELEMENT_ID
public static final java.lang.String NAME_ATTRIBUTE
public static final java.lang.String TYPE_ATTRIBUTE
public static final java.lang.String ID_ATTRIBUTE
public static final java.lang.String ENTITY_LIST
Constructor Detail |
---|
public EntityMap()
Method Detail |
---|
public int getNumEntities()
public java.util.List getEntities()
public EntityMap.Entity getEntity(int entityIndex)
public java.lang.String getEntityName(java.lang.String entityID, java.lang.String defaultVal)
public java.lang.String getEntityLabel(java.lang.String entityID)
public EntityMap.Entity getEntityForID(java.lang.String entityID)
public void addEntity(EntityMap.Entity newEntity)
public void removeEntity(EntityMap.Entity entityToRemove)
public void loadFromObject(DigitalObject obj) throws java.lang.Exception
java.lang.Exception
public void saveToObject(DigitalObject obj) throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |