com.ibm.mm.beans
Class CMBAttribute
java.lang.Object
|
+--com.ibm.mm.beans.CMBAttribute
- All Implemented Interfaces:
- CMBBaseConstant, java.io.Serializable
- public class CMBAttribute
- extends java.lang.Object
- implements java.io.Serializable, CMBBaseConstant
This is a helper class for the CMBSchemaManagement bean. This class
provides functions for manipulation of attribute meta data:
- data type
- maximum value
- minimum value
- whether it is nullable
- whether it is queryable
- etc.
- Since:
- 6.1
- See Also:
CMBSchemaManagement
, Serialized Form
Fields inherited from interface com.ibm.mm.beans.CMBBaseConstant |
ANNOTATION_MIME_TYPE, CMB_CLASS_ICM_DOC_MODEL, CMB_CLASS_ICM_DOC_PART, CMB_CLASS_ITEM, CMB_CLASS_RESOURCE_ITEM, CMB_CLASS_UNDEFINED, CMB_CONNTYPE_DYNAMIC, CMB_CONNTYPE_LOCAL, CMB_CONNTYPE_REMOTE, CMB_CONTENT_ATTRONLY, CMB_CONTENT_CHILDREN, CMB_CONTENT_ITEMTREE, CMB_CONTENT_LINKS_INBOUND, CMB_CONTENT_LINKS_OUTBOUND, CMB_CONTENT_YES, CMB_DATATYPE_COLLECTION, CMB_DATATYPE_COLLECTION_DDO, CMB_DATATYPE_COLLECTION_XDO, CMB_DATATYPE_DATAOBJECTBASE, CMB_DATATYPE_DATE, CMB_DATATYPE_DECIMAL, CMB_DATATYPE_DOUBLE, CMB_DATATYPE_FLOAT, CMB_DATATYPE_FSTRING, CMB_DATATYPE_ITEM, CMB_DATATYPE_ITEM_COLLECTION, CMB_DATATYPE_LONG, CMB_DATATYPE_OBJECT, CMB_DATATYPE_OBJECT_COLLECTION, CMB_DATATYPE_SHORT, CMB_DATATYPE_TIME, CMB_DATATYPE_TIMESTAMP, CMB_DATATYPE_UNDEFINED, CMB_DATATYPE_VSTRING, CMB_DSTYPE_CM, CMB_DSTYPE_DB2, CMB_DSTYPE_DES, CMB_DSTYPE_DJ, CMB_DSTYPE_DL, CMB_DSTYPE_DOMDOC, CMB_DSTYPE_FED, CMB_DSTYPE_FN, CMB_DSTYPE_IC, CMB_DSTYPE_ICM, CMB_DSTYPE_IP390, CMB_DSTYPE_JDBC, CMB_DSTYPE_OD, CMB_DSTYPE_VI400, CMB_EIP_LOGOUT, CMB_OBJTYPE_CMBITEM, CMB_OBJTYPE_CMBOBJECT, CMB_OP_AND, CMB_OP_BETWEEN, CMB_OP_CONTAINS_TEXT, CMB_OP_CONTAINS_TEXT_IN_CONTENT, CMB_OP_EQUAL, CMB_OP_GREATER, CMB_OP_GREATER_EQUAL, CMB_OP_IN, CMB_OP_LESS, CMB_OP_LESS_EQUAL, CMB_OP_LIKE, CMB_OP_NOT, CMB_OP_NOT_BETWEEN, CMB_OP_NOT_EQUAL, CMB_OP_NOT_IN, CMB_OP_NOT_LIKE, CMB_OP_OR, CMB_OP_UNDEFINED, CMB_QS_TYPE_COMBINED, CMB_QS_TYPE_DES, CMB_QS_TYPE_FEDERATED, CMB_QS_TYPE_IMAGE, CMB_QS_TYPE_PARAMETRIC, CMB_QS_TYPE_SQL, CMB_QS_TYPE_TEMPLATE, CMB_QS_TYPE_TEXT, CMB_QS_TYPE_UNKNOWN, CMB_QS_TYPE_XPATH, CMB_ST_SKIP_ALWAYS, CMB_ST_SKIP_NEVER, CMB_ST_SKIP_WITH_PROMPT, CMB_STATUS_FAILED, CMB_STATUS_OK, CMB_STATUS_RESULT_END, CMB_STATUS_RESULT_MORE, CMB_STATUS_RESULT_NEW, CMB_TIMESTAMP_UNDEFINED, CMB_TYPE_DOCUMENT, CMB_TYPE_FOLDER, CMB_TYPE_ITEM, CMB_TYPE_UNKNOWN, CMB_USERID_UNDEFINED, CMB_VERSION_CONTROL_ALWAYS_NEW, CMB_VERSION_CONTROL_BY_APP, CMB_VERSION_CONTROL_NEVER, CMB_VERSION_KEYWORD, CMB_VERSION_LATEST, CMB_VERSION_NEW, PROP_CACHE_ENABLED, PROP_CC2MIME_URL, PROP_CONNECTION, PROP_CONNECTION_TYPE, PROP_DATA_MANAGEMENT_ENABLED, PROP_DSTYPE, PROP_LOCAL_SERVER, PROP_NAME, PROP_NEW_PASSWORD, PROP_PASSWORD, PROP_PORT_NUMBER, PROP_QUERY_CALLBACK_THRESHOLD, PROP_QUERY_MAX_RESULTS, PROP_RESULT_PAGESIZE, PROP_RMI_HOSTNAME, PROP_SCHEMA_MANAGEMENT_ENABLED, PROP_SEARCH_ASYNCH, PROP_SEARCH_MULTI_CHARS_WILDCARD, PROP_SEARCH_PARAMETRIC_WILDCARD, PROP_SEARCH_SINGLE_CHAR_WILDCARD, PROP_SEARCH_SKIP_SERVER, PROP_SEARCH_TIMEOUT, PROP_SERVER_NAME, PROP_SV_CONNECTION_TYPE, PROP_SV_PORT_NUMBER, PROP_SV_RMI_HOSTNAME, PROP_TRACE_ENABLED, PROP_USERID |
Method Summary |
java.lang.String |
getDefaultValue()
Gets the default value for the attribute. |
java.lang.String |
getDescription()
Gets the attribute description |
java.lang.String |
getEntityName()
Gets the parent entity name: index class, table, etc. |
int |
getMax()
Gets maximum value for this attribute |
int |
getMin()
Gets the minimum value for this attribute |
java.lang.String |
getName()
Gets this attribute name |
int |
getPrecision()
Gets precision value for this attribute |
int |
getScale()
Gets scale value of this attribute if its type is decimal. |
java.lang.String |
getServerName()
Gets the server name of this attribute. |
int |
getSize()
Gets the display size for this attribute (applicable for String only) |
int |
getStringType()
Gets the string type value for this attribute |
short |
getType()
Gets data type of this attribute |
boolean |
isNullable()
Checks if this attribute is nullable. |
boolean |
isQueryable()
Checks if this attribute is queryable. |
boolean |
isTextSearchable()
Checks if this attribute is text searchable. |
boolean |
isUpdatable()
Checks if this attribute is updatable. |
void |
setName(java.lang.String attrName)
Sets name for this attribute |
java.lang.String |
toString()
Useful for tracing and debugging |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
CMB_ATTR_STRING_NONE
public static final int CMB_ATTR_STRING_NONE
- string type: the string type is undefined
CMB_ATTR_STRING_ALPHA
public static final int CMB_ATTR_STRING_ALPHA
- string type: the string contains alphabetic characters only
CMB_ATTR_STRING_ALPHANUM
public static final int CMB_ATTR_STRING_ALPHANUM
- string type: the string contains alpha-numeric characters
CMB_ATTR_STRING_ALPHANUM_EXT
public static final int CMB_ATTR_STRING_ALPHANUM_EXT
- string type: the string contains alpha-numeric and other special characters
CMB_ATTR_STRING_NUMERIC
public static final int CMB_ATTR_STRING_NUMERIC
- string type: the string only contains numeric characters
CMB_ATTR_STRING_OTHER
public static final int CMB_ATTR_STRING_OTHER
- string type: the string may follow application defined rules and
the interpretation is left to the application
CMBAttribute
public CMBAttribute()
- Default constructor
getServerName
public java.lang.String getServerName()
- Gets the server name of this attribute.
- Returns:
- server name
getEntityName
public java.lang.String getEntityName()
- Gets the parent entity name: index class, table, etc.
- Returns:
- name of parent entity
getName
public java.lang.String getName()
- Gets this attribute name
- Returns:
- name of this attribute
setName
public void setName(java.lang.String attrName)
- Sets name for this attribute
- Parameters:
attrName
- new name for this attribute
getDescription
public java.lang.String getDescription()
- Gets the attribute description
- Returns:
- attribute description
getDefaultValue
public java.lang.String getDefaultValue()
- Gets the default value for the attribute. Valid only for CM V8
- Returns:
- default value
- Since:
- 8.1
getType
public short getType()
- Gets data type of this attribute
- Returns:
- attribute data type
- See Also:
CMBBaseConstant
getSize
public int getSize()
- Gets the display size for this attribute (applicable for String only)
- Returns:
- display size
isNullable
public boolean isNullable()
- Checks if this attribute is nullable. Default is true.
- Returns:
- true if this attribute is nullable, false otherwise
getPrecision
public int getPrecision()
- Gets precision value for this attribute
- Returns:
- precision value
getScale
public int getScale()
- Gets scale value of this attribute if its type is decimal.
- Returns:
- minimum value for short/long
getMax
public int getMax()
- Gets maximum value for this attribute
- Returns:
- maximum value
getMin
public int getMin()
- Gets the minimum value for this attribute
- Returns:
- the valid lower bound for this attribute
getStringType
public int getStringType()
- Gets the string type value for this attribute
- Returns:
- the string type for this attribute,
either numeric, alphabetic, alpanumeric, etc. The valid
value is one of the following constants :
- CMB_ATTR_STRING_NONE: the string type is undefined
- CMB_ATTR_STRING_ALPHA: the string contains alphabetic characters only
- CMB_ATTR_STRING_ALPHANUM: the string contains alpha-numeric characters
- CMB_ATTR_STRING_ALPHANUM_EXT: the string contains alpha-numeric and other special characters
- CMB_ATTR_STRING_NUMERIC: the string only contains numeric characters
- CMB_ATTR_STRING_OTHER: the string may follow application defined rules and
the interpretation is left to the application
isUpdatable
public boolean isUpdatable()
- Checks if this attribute is updatable.
- Returns:
- true if this attribute is updatable, false otherwise
isQueryable
public boolean isQueryable()
- Checks if this attribute is queryable. Default value is true.
- Returns:
- true if this attribute is queryable, false otherwise
isTextSearchable
public boolean isTextSearchable()
- Checks if this attribute is text searchable. Default value is false.
- Returns:
- true if this attribute is text searchable, false otherwise
- Since:
- 8.1
toString
public java.lang.String toString()
- Useful for tracing and debugging
- Overrides:
toString
in class java.lang.Object
- Since:
- 8.1
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.