|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An object representing a schema for a set of the documents.
Field Summary | |
static int |
BOOLEAN
Deprecated. Specifies a boolean attribute (0). |
static int |
DATETIME
Deprecated. Specifies a date/time attribute (4). |
static int |
FLOAT
Deprecated. Specifies a float attribute (2). |
static int |
INTEGER
Deprecated. Specifies an integer attribute (1). |
static int |
TEXT
Deprecated. Specifies a text attribute (3). |
static int |
USER_DEFINED
Deprecated. Specifes a user definined (object) attribute (5). |
Method Summary | |
Object |
getAttributeDefaultValue(String attributeName)
Deprecated. Get the default value for the named attribute. |
String |
getAttributeDescription(String attributeName)
Deprecated. Get a text description of the attribute. |
Collection |
getAttributeNames()
Deprecated. Returns the list of valid attribute names in this schema. |
List |
getAttributePossibleValues(String attributeName)
Deprecated. Return the list of possible values for a multi-vauled attribute. |
int |
getAttributeType(String attributeName)
Deprecated. Returns the type of the named attribute. |
String |
getDescription()
Deprecated. Returns the schema description. |
String |
getName()
Deprecated. Returns the schema name. |
boolean |
isAttributeMultiValued(String attributeName)
Deprecated. Tell if the named attribute is a multi-valued attribute (i.e. its value in the DocumentMetadata is really a List). |
boolean |
validateAttribute(String attributeName,
Object attributeValue)
Deprecated. Validate that a given attribute value is valid based upon the schema information. |
Field Detail |
public static final int BOOLEAN
public static final int DATETIME
public static final int FLOAT
public static final int INTEGER
public static final int TEXT
public static final int USER_DEFINED
Method Detail |
public Object getAttributeDefaultValue(String attributeName) throws DocumentException
attributeName
- the name of the attribute.
DocumentException
- thrown on an error.public String getAttributeDescription(String attributeName) throws DocumentException
attributeName
- the name of the attribute.
DocumentException
- thrown on an error.public Collection getAttributeNames() throws DocumentException
DocumentException
- thrown on an error.public List getAttributePossibleValues(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.
DocumentException
- thrown on an error.public int getAttributeType(String attributeName) throws DocumentException
attributeName
- the name of the attribute.
DocumentException
- thrown on an error.TEXT
,
INTEGER
,
FLOAT
,
BOOLEAN
,
DATETIME
,
USER_DEFINED
public String getDescription() throws DocumentException
DocumentException
- thrown on an error.public String getName() throws DocumentException
DocumentException
- thrown on an error.public boolean isAttributeMultiValued(String attributeName) throws DocumentException
attributeName
- the name of the attribute.
DocumentException
- thrown on an error.public boolean validateAttribute(String attributeName, Object attributeValue) throws DocumentException
attributeName
- the name of the attribute.attributeValue
- the suggested value for the attribute.
DocumentException
- thrown on an error.
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |