|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Container is a generic container for objects that are stored in a collection. A container can either contain a DocumentTable or a Value, depending on the collection type. Container associates the internal document or binary representation with its original collection and key, so that the contents of the container can be stored without having to maintain three separate references.
Field Summary | |
static int |
TYPE_DOCUMENT
|
static int |
TYPE_VALUE
|
Method Summary | |
java.lang.String |
getCanonicalName()
getCanonicalName returns the canonical name for the contained Object. |
Collection |
getCollection()
getCollection returns the Collection that the Object contained belongs to. |
int |
getContainerType()
getContainerType returns the type of Object being contained by this Container. |
DocumentTable |
getDocument()
getDocument returns the contained Document. |
Key |
getKey()
getKey returns the Object Key. |
Value |
getValue()
getValue returns the contained Value (if any). |
void |
remove()
remove removes the Object from the Collection. |
void |
reset()
reset reloads the Object from the Collection. |
void |
setDocument(DocumentTable document)
setDocument replaces the Document in the Collection with the specified Document. |
void |
setValue(Value value)
setValue replaces the Value in the Collection with the specified Value. |
Field Detail |
public static final int TYPE_DOCUMENT
public static final int TYPE_VALUE
Method Detail |
public int getContainerType()
public Collection getCollection()
public Key getKey()
public java.lang.String getCanonicalName() throws DBException
DBException
- If a Database Exception occurspublic DocumentTable getDocument() throws DBException
DBException
- if a DocumentTable is not containedpublic Value getValue() throws DBException
DBException
- if a Value is not containedpublic void reset() throws DBException
DBException
- If a Database Exception occurspublic void remove() throws DBException
DBException
- If a Database Exception occurspublic void setDocument(DocumentTable document) throws DBException
document
- The Document
DBException
- if Collection doesn't store Documentspublic void setValue(Value value) throws DBException
value
- The Value
DBException
- if Collection doesn't store Values
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |