| java.lang.Object com.sun.portal.search.rdm.RDMSchema
RDMSchema | public class RDMSchema (Code) | | RDM Schema
A Schema specifies how to interpret the SOIF objects for a given
Schema-Name. For example, a schema may define that the SOIF object
called @DOCUMENT may contain the following Attributes:
Author, Last-Modified, Description, Content-Length, etc.
Furthermore, define how to interpret the individual values for
those Attributes. For example, the Author attribute's value may be
defined as a string.
The RDM @SCHEMA definition contains the following attributes:
column-name multivalued
content-type multivalued
data-type multivalued
default-view-attribute multivalued
default-view-order multivalued
enforce-uniqueness multivalued
foreign-key-system-column-name multivalued
foreign-key-system-table-name multivalued
in-root-table multivalued
index-attribute multivalued
is-internal multivalued
score-multiplier multivalued (PS 6.1)
number-of-entries single-value
schema-definition-language-version single-value
schema-name single-value
soif-attribute multivalued
system-column-name multivalued
system-table-name multivalued
table-name multivalued
|
Method Summary | |
public String | aliasesToString() | protected void | createAliasMap() | public void | deleteColumn(int column) | public void | deleteColumn(String columnName) | final public String | getAliases(int column) | public static SOIF | getClassificationSchemaSOIF() | final public String | getColumnName(int column) | public int | getColumnNumber(String columnName) | final public String | getContentType(int column) | final public String | getDBIndexAttribute(int column) | final public String | getDataType(int column) | public static SOIF | getDatabaseSchemaSOIF() | final public String | getDescription(int column) | final public String | getEditAttribute(int column) | final public String | getEnforceUnique(int column) | final public String | getFKSysColumnName(int column) | final public String | getFKSysTableName(int column) | final public String | getInRoot(int column) | final public String | getIndexAttribute(int column) | final public String | getIsAlertable(int column) | final public String | getIsInternal(int column) | final public int | getMaxIndex() | final public String | getName() | final public String | getNumEntries() | final public int | getNumEntriesInt() | final public SOIF | getSOIF() | final public String | getSOIFAttribute(int column) Macros for accessing common multi-valued @SCHEMA values
Use prototype: char *getXXX(RDMSchema *schema, int MultivalcolumnNum). | public static RDMSchema | getSchema(String objType) | final public String | getSysColumnName(int column) | final public String | getSysTableName(int column) | final public String | getTableName(int column) | final public String | getValue(String field, String attr) | final public String | getVersion() | final public String | getViewAttributeDefault(int column) | final public String | getViewOrderDefault(int column) | public int | mapAliases(SOIF s) | public static RDMSchema | register(RDMSchema rds) | final void | removeOrReplace(String field, String value, int column) | public String | schema_attr_type(String attr) | public String[] | schema_index_attrs() | public String[] | schema_nonInternal_attrs() | final public void | setAliases(int column, String s) | final public void | setColumnName(int column, String s) | final public void | setContentType(int column, String s) | final public void | setDBIndexAttribute(int column, String s) | final public void | setDataType(int column, String s) | final public void | setDescription(int column, String s) | final public void | setEditAttribute(int column, String s) | final public void | setEnforceUnique(int column, String s) | final public void | setFKSysColumnName(int column, String s) | final public void | setFKSysTableName(int column, String s) | final public void | setInRoot(int column, String s) | final public void | setIndexAttribute(int column, String s) | final public void | setIsAlertable(int column, String s) | final public void | setIsInternal(int column, String s) | final public void | setName(String s) | final public void | setNumEntries(String s) | final public void | setSOIFAttribute(int column, String s) Macros for defining common multi-valued @SCHEMA values
Use prototype: int setXXX(RDMSchema *schema,
int MultivalcolumnNum, char *newval). | final public void | setSysColumnName(int column, String s) | final public void | setSysTableName(int column, String s) | final public void | setTableName(int column, String s) | final public void | setValue(String field, String attr, String value) | final public void | setVersion(String s) | final public void | setViewAttributeDefault(int column, String s) | final public void | setViewOrderDefault(int column, String s) |
deleteColumn | public void deleteColumn(int column)(Code) | | To remove a numbered column from the RDMSchema object
|
deleteColumn | public void deleteColumn(String columnName)(Code) | | To remove a named column from the RDMSchema object
|
getClassificationSchemaSOIF | public static SOIF getClassificationSchemaSOIF()(Code) | | Creates new ClassificationSchema
|
getColumnName | final public String getColumnName(int column)(Code) | | |
getColumnNumber | public int getColumnNumber(String columnName)(Code) | | |
getContentType | final public String getContentType(int column)(Code) | | |
getDBIndexAttribute | final public String getDBIndexAttribute(int column)(Code) | | |
getDataType | final public String getDataType(int column)(Code) | | |
getDatabaseSchemaSOIF | public static SOIF getDatabaseSchemaSOIF()(Code) | | Creates new ClassificationSchema
|
getDescription | final public String getDescription(int column)(Code) | | |
getEditAttribute | final public String getEditAttribute(int column)(Code) | | |
getEnforceUnique | final public String getEnforceUnique(int column)(Code) | | |
getFKSysColumnName | final public String getFKSysColumnName(int column)(Code) | | |
getFKSysTableName | final public String getFKSysTableName(int column)(Code) | | |
getIndexAttribute | final public String getIndexAttribute(int column)(Code) | | |
getIsAlertable | final public String getIsAlertable(int column)(Code) | | |
getIsInternal | final public String getIsInternal(int column)(Code) | | |
getMaxIndex | final public int getMaxIndex()(Code) | | |
getNumEntriesInt | final public int getNumEntriesInt()(Code) | | |
getSOIFAttribute | final public String getSOIFAttribute(int column)(Code) | | Macros for accessing common multi-valued @SCHEMA values
Use prototype: char *getXXX(RDMSchema *schema, int MultivalcolumnNum).
|
getSysColumnName | final public String getSysColumnName(int column)(Code) | | |
getSysTableName | final public String getSysTableName(int column)(Code) | | |
getTableName | final public String getTableName(int column)(Code) | | |
getVersion | final public String getVersion()(Code) | | Macros for accessing single-value @SCHEMA values
Use prototype: char *getXXX(RDMSchema *s)
|
getViewAttributeDefault | final public String getViewAttributeDefault(int column)(Code) | | |
getViewOrderDefault | final public String getViewOrderDefault(int column)(Code) | | |
mapAliases | public int mapAliases(SOIF s)(Code) | | This modifies the SOIF by renaming aliased attributes to their cnames
|
schema_index_attrs | public String[] schema_index_attrs()(Code) | | array of indexed attributes |
schema_nonInternal_attrs | public String[] schema_nonInternal_attrs()(Code) | | array of non-internal attributes |
setAliases | final public void setAliases(int column, String s)(Code) | | |
setColumnName | final public void setColumnName(int column, String s)(Code) | | |
setContentType | final public void setContentType(int column, String s)(Code) | | |
setDBIndexAttribute | final public void setDBIndexAttribute(int column, String s)(Code) | | |
setDataType | final public void setDataType(int column, String s)(Code) | | |
setDescription | final public void setDescription(int column, String s)(Code) | | |
setEditAttribute | final public void setEditAttribute(int column, String s)(Code) | | |
setEnforceUnique | final public void setEnforceUnique(int column, String s)(Code) | | |
setFKSysColumnName | final public void setFKSysColumnName(int column, String s)(Code) | | |
setFKSysTableName | final public void setFKSysTableName(int column, String s)(Code) | | |
setInRoot | final public void setInRoot(int column, String s)(Code) | | |
setIndexAttribute | final public void setIndexAttribute(int column, String s)(Code) | | |
setIsAlertable | final public void setIsAlertable(int column, String s)(Code) | | |
setIsInternal | final public void setIsInternal(int column, String s)(Code) | | |
setNumEntries | final public void setNumEntries(String s)(Code) | | |
setSOIFAttribute | final public void setSOIFAttribute(int column, String s)(Code) | | Macros for defining common multi-valued @SCHEMA values
Use prototype: int setXXX(RDMSchema *schema,
int MultivalcolumnNum, char *newval).
|
setSysColumnName | final public void setSysColumnName(int column, String s)(Code) | | |
setSysTableName | final public void setSysTableName(int column, String s)(Code) | | |
setTableName | final public void setTableName(int column, String s)(Code) | | |
setVersion | final public void setVersion(String s)(Code) | | Macros for defining single-value @SCHEMA values
Use prototype: int setXXX(RDMSchema *schema, char *newval)
|
setViewAttributeDefault | final public void setViewAttributeDefault(int column, String s)(Code) | | |
setViewOrderDefault | final public void setViewOrderDefault(int column, String s)(Code) | | |
|
|