|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An object representing a schema for a set of the documents.
Field Summary | |
static int |
BOOLEAN
Specifies a boolean attribute. |
static int |
DATETIME
Specifies a date/time attribute. |
static int |
FLOAT
Specifies a float attribute. |
static int |
INTEGER
Specifies an integer attribute. |
static int |
TEXT
Specifies a text attribute. |
static int |
USER_DEFINED
Specifes a user definined (object) attribute. |
Method Summary | |
java.lang.Object |
getAttributeDefaultValue(java.lang.String attributeName)
Get the default value for the named attribute. |
java.lang.String |
getAttributeDescription(java.lang.String attributeName)
Get a text description of the attribute. |
java.util.Collection |
getAttributeNames()
Returns the list of valid attribute names in this schema. |
java.util.List |
getAttributePossibleValues(java.lang.String attributeName)
Return the list of possible values for a multi-vauled attribute. |
int |
getAttributeType(java.lang.String attributeName)
Returns the type of the named attribute. |
java.lang.String |
getDescription()
Returns the schema description. |
java.lang.String |
getName()
Returns the schema name. |
boolean |
isAttributeMultiValued(java.lang.String attributeName)
Tell if the named attribute is a multi-valued attribute (i.e. |
boolean |
validateAttribute(java.lang.String attributeName,
java.lang.Object attributeValue)
Validate that a given attribute value is valid based upon the schema information. |
Field Detail |
public static final int TEXT
TypesHelper.TEXT
public static final int INTEGER
TypesHelper.INTEGER
public static final int FLOAT
TypesHelper.FLOAT
public static final int BOOLEAN
TypesHelper.BOOLEAN
public static final int DATETIME
TypesHelper.DATETIME
public static final int USER_DEFINED
TypesHelper.USER_DEFINED
Method Detail |
public java.lang.String getName() throws DocumentException
public java.lang.String getDescription() throws DocumentException
public java.util.Collection getAttributeNames() throws DocumentException
public int getAttributeType(java.lang.String attributeName) throws DocumentException
attributeName
- the name of the attribute.TEXT
,
INTEGER
,
FLOAT
,
BOOLEAN
,
DATETIME
,
USER_DEFINED
public java.lang.Object getAttributeDefaultValue(java.lang.String attributeName) throws DocumentException
attributeName
- the name of the attribute.public java.lang.String getAttributeDescription(java.lang.String attributeName) throws DocumentException
attributeName
- the name of the attribute.public boolean isAttributeMultiValued(java.lang.String attributeName) throws DocumentException
attributeName
- the name of the attribute.public java.util.List getAttributePossibleValues(java.lang.String attributeName) throws DocumentException
This returns null for non multi-valued attributes and multi-valued attributes which are not restricted to a set of possible values.
attributeName
- the name of the attribute.public boolean validateAttribute(java.lang.String attributeName, java.lang.Object attributeValue) throws DocumentException
attributeName
- the name of the attribute.attributeValue
- the suggested value for the attribute.
|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |