|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Fields belong to documents (or versions of documents), and can be used for various purposes.
Often, fields will be used for meta-data about the document, though
you can use them for whatever data that you want to have addressable
on a finer level then that contained in the Parts
.
A field is always based upon a FieldType
,
which defines the kind of data that the field can contain.
Note that a field has no setters methods, modifications can only
be done through the containing Document
. This is because
fields can also be obtained from Version
s, which are not
modifiable.
Method Summary | |
long |
getTypeId()
The id of the field type of this field. |
java.lang.String |
getTypeName()
The name of the field type (for convenience, this is retrieved from the RepositorySchema). |
java.lang.Object |
getValue()
The value of the field. |
ValueType |
getValueType()
The ValueType of the field, which defines the kind of object you will get from getValue() . |
org.outerx.daisy.x10.FieldDocument |
getXml()
Get an XML document describing this field. |
boolean |
isMultiValue()
Indicates if this field is a multivalue field. |
Method Detail |
public long getTypeId()
RepositorySchema
.
public java.lang.String getTypeName()
public ValueType getValueType()
getValue()
. This method is here for convenience,
the information is retrieved from the RepositorySchema.
public boolean isMultiValue()
public java.lang.Object getValue()
ValueType
, and of whether it concerns a multi-value
field type. For multi-value fields, an array (Object[]) is returned.
public org.outerx.daisy.x10.FieldDocument getXml()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |