|
Vordel SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TypeStore
Defines a common interface for retrieving Entity type information,
EntityTypes, which in turn describe Entity structure.
Broken out from the EntityStore API for possible future enhancements, whereby
Entities may exist outside of any given store. Practically speaking, an
EntityStore can never exist without a corresponding TypeStore, but Entities
may exist (in the future) without belonging to a particular
EntityStore, but will always require a TypeStore to house their EntityType
definitons.
Field Summary | |
---|---|
static java.lang.String |
BASE_TYPE_NAME
The root EntityType name. |
Method Summary | |
---|---|
EntityType |
addType(java.io.InputStream stream)
This method adds a new type to the EntityStore |
EntityType |
getBaseType()
This method is used to retrieve the base entity type definition. |
java.util.Collection<java.lang.String> |
getSubtypes(java.lang.String type)
Get the names of the immediate descendants of the type specified. |
EntityType |
getTypeForName(java.lang.String name)
This method is used to retrieve an EntityType based on it's name. |
void |
reset()
Remove all non-default Entities and reset the core Types. |
EntityType |
updateType(java.io.InputStream stream)
This method updates a type in the EntityStore with a new definiton. |
Field Detail |
---|
static final java.lang.String BASE_TYPE_NAME
Method Detail |
---|
EntityType getBaseType() throws EntityStoreException
EntityStoreException
- if an error occursEntityType getTypeForName(java.lang.String name) throws EntityStoreException, UnknownTypeException
name
-
EntityStoreException
- if there was a problem retrieving the
type from the underlying persistent store
UnknownTypeException
- if no type for this name existsjava.util.Collection<java.lang.String> getSubtypes(java.lang.String type) throws EntityStoreException
type
- The name of the parent type
EntityStoreExeption
- Thrown if the type specified does not
exist in the Store.
EntityStoreException
EntityType addType(java.io.InputStream stream) throws EntityStoreException
stream
- The stream from which to read the EntityType definition
EntityStoreException
- Thrown if the type already exists.EntityType updateType(java.io.InputStream stream) throws EntityStoreException
stream
- The stream from which to read the EntityType definition
EntityStoreException
- Thrown if the type does not already exist.void reset() throws EntityStoreException
EntityStoreException
- if the store cannot be cleared
|
Vordel SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |