|
IBM Information Integrator for Content V8.2 APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.infomining.DKIKFCatalog
A catalog is an object that can be used to store, retrieve and search for records.
Constructor Summary | |
protected |
DKIKFCatalog()
Objects can be obtained from DKIKFLibrary . |
Method Summary | |
abstract void |
createRecord(DKIKFRecord record,
DKIKFCategory[] categories)
Creates a new record in the catalog and assigns it to the specified categories. |
abstract void |
deleteRecord(java.lang.String pid)
Deletes the record with the specified PID in the catalog. |
abstract DKIKFCategory[] |
getCategoriesForRecord(java.lang.String pid)
Returns all categories to which the record with the specifed PID is assigned. |
abstract java.lang.String |
getDescription()
Returns the description for the catalog. |
abstract java.lang.String |
getName()
Returns the name of the catalog. |
abstract DKIKFRecord |
getRecord(java.lang.String pid)
Returns the record for the specified PID. |
abstract DKIKFRecord |
getRecord(java.lang.String pid,
java.lang.String[] keys)
Returns the record for the specified PID containing only the values for the specified keys. |
abstract DKIKFSchema |
getSchema()
Returns the schema of the catalog. |
abstract DKIKFService |
getService()
Returns the service object used by this catalog. |
abstract DKIKFTaxonomy |
getTaxonomy()
Returns the most recent version of the catalogs taxonomy. |
abstract java.sql.Timestamp |
getTaxonomyLastModified()
Returns the time the taxonomy has been last modified (categories created, deleted or renamed). |
abstract boolean |
recordExists(java.lang.String pid)
Checks if a record with the specified PID exists in the specified catalog. |
abstract DKIKFSearchResult |
searchRecords(java.lang.String queryString,
DKIKFSearchConfiguration configuration)
Searches for records using the specified query string and search configuration. |
abstract void |
updateRecord(DKIKFRecord record)
Updates the record in the catalog. |
abstract void |
updateRecord(DKIKFRecord record,
DKIKFCategory[] categories)
Updates the record in the catalog. |
abstract void |
updateRecord(java.lang.String pid,
DKIKFCategory[] categories)
Updates the category assignmet of the record with the specified PID. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected DKIKFCatalog()
DKIKFLibrary
.Method Detail |
public abstract java.lang.String getName() throws DKIKFNoSuchCatalogException
DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privilege IKFRetrieveCatalogpublic abstract java.lang.String getDescription() throws DKIKFNoSuchCatalogException
DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privilege IKFRetrieveCatalogpublic abstract java.sql.Timestamp getTaxonomyLastModified() throws DKIKFNoSuchCatalogException
DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privilege IKFRetrieveCatalogpublic abstract DKIKFSchema getSchema() throws DKIKFNoSuchCatalogException
DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privilege IKFRetrieveCatalogpublic abstract DKIKFTaxonomy getTaxonomy() throws DKIKFNoSuchCatalogException
DKIKFTaxonomy.getTimestamp()
and getTaxonomyLastModified()
to compare a retrieved taxonomy to the current catalog taxonomy.DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFRetrieveCategorypublic abstract boolean recordExists(java.lang.String pid) throws DKIKFNoSuchCatalogException
true
if the record exists;false
otherwiseDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFRetrieveRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
getRecord(String)
public abstract void createRecord(DKIKFRecord record, DKIKFCategory[] categories) throws DKIKFNoSuchCatalogException, DKIKFRecordAlreadyExistsException, DKIKFNoSuchCategoryException, DKIKFSizeOutOfBoundsException
updateRecord
methods to update the record in the catalog.record
- the record to be created in the catalogDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFRecordAlreadyExistsException
- if a record with the PID stored in the record object already exists in the catalogDKIKFEmptyCategoryArrayException
- if the specified category array is emptyDKIKFNoSuchCategoryException
- if at least one of the specified categories doesn't existDKIKFNoSuchKeyException
- if the specified record contains a key that is not available in the catalog schemaDKIKFInvalidTypeException
- if the specified record contains an value that is of the wrong type according to the catalog schemaDKIKFSizeOutOfBoundsException
- if the specified record exceeds the database limitsDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog,
IKFRetrieveCategory and
IKFCreateRecorddeleteRecord(String)
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
getRecord(String)
public abstract void deleteRecord(java.lang.String pid) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException
pid
- the PID of the record to be deletedDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if a record with the specified PID doesn't exist in the catalogDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFDeleteRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
getRecord(String)
public abstract void updateRecord(DKIKFRecord record) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException, DKIKFSizeOutOfBoundsException
record
- the record to be used for updateDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFNoSuchKeyException
- if the specified record contains a key that is not available in the catalog schemaDKIKFInvalidTypeException
- if the specified record contains an value that is of the wrong type according to the catalog schemaDKIKFSizeOutOfBoundsException
- if the specified record exceeds the database limitsDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog,
IKFRetrieveRecord and
IKFUpdateRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
updateRecord(String,DKIKFCategory[])
,
getRecord(String)
public abstract void updateRecord(DKIKFRecord record, DKIKFCategory[] categories) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException, DKIKFNoSuchCategoryException, DKIKFSizeOutOfBoundsException
record
- the record to be used for updatecateogries
- the categories to which the record will be assignedDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFEmptyCategoryArrayException
- if the specified category array is emptyDKIKFNoSuchCategoryException
- if at least one of the specified categories doesn't existDKIKFNoSuchKeyException
- if the specified record contains a key that is not available in the catalog schemaDKIKFInvalidTypeException
- if the specified record contains an value that is of the wrong type according to the catalog schemaDKIKFSizeOutOfBoundsException
- if the specified record exceeds the database limitsDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog,
IKFRetrieveRecord,
IKFRetrieveCategory and
IKFUpdateRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
updateRecord(DKIKFRecord)
,
updateRecord(String,DKIKFCategory[])
,
getRecord(String)
public abstract void updateRecord(java.lang.String pid, DKIKFCategory[] categories) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException, DKIKFNoSuchCategoryException
pid
- the PID of the record to be updatedcateogries
- the categories to which the record will be assignedDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFEmptyCategoryArrayException
- if the specified category array is emptyDKIKFNoSuchCategoryException
- if at least one of the specified categories doesn't existDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog,
IKFRetrieveRecord,
IKFRetrieveCategory and
IKFUpdateRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
updateRecord(DKIKFRecord)
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
getRecord(String)
public abstract DKIKFRecord getRecord(java.lang.String pid) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException
pid
- the PID of the record to be retrievedDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFRetrieveRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
updateRecord(DKIKFRecord)
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
updateRecord(String,DKIKFCategory[])
public abstract DKIKFRecord getRecord(java.lang.String pid, java.lang.String[] keys) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException
pid
- the PID of the record to be retrievedkeys
- the keys of the values to be retrievedDKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFNoSuchKeyException
- if one of the the specified keys is not available in the catalog schemaDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFRetrieveRecordcreateRecord(DKIKFRecord,DKIKFCategory[])
,
deleteRecord(String)
,
updateRecord(DKIKFRecord)
,
updateRecord(DKIKFRecord,DKIKFCategory[])
,
updateRecord(String,DKIKFCategory[])
public abstract DKIKFCategory[] getCategoriesForRecord(java.lang.String pid) throws DKIKFNoSuchCatalogException, DKIKFNoSuchRecordException
DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFNoSuchRecordException
- if the record doesn't exist in the catalogDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog,
IKFRetrieveRecord and
IKFRetrieveCategorypublic abstract DKIKFSearchResult searchRecords(java.lang.String queryString, DKIKFSearchConfiguration configuration) throws DKIKFNoSuchCatalogException, DKIKFTaxonomyNotSetException, DKIKFNoSuchCategoryException, DKIKFQueryException
query_string ::= term term ::= ( term ) ::= single_term ::= compound_term single_term ::= category_term ::= text_search_term ::= string_term ::= number_term compound_term ::= term binary_bool_operator term ::= unary_bool_operator single_term category_term ::= ( DKIKFCategory category_operator category_path_value ) text_search_term ::= ( "attribute name" CONTAINS text_search_value ) string_term ::= ( "attribute name" string_operator string_value ) number_term ::= ( "attribute name" basic_operator number_value ) binary_bool_operator ::= AND | OR unary_bool_operator ::= NOT category_operator ::= >= | = string_operator ::= LIKE | basic_operator basic_operator ::= > | < | <= | >= | != | = category_path_value ::= "category path" text_search_value ::= "'string'" string_value ::= "string" number_value ::= "integer" | "decimal number"Example:
("IKF_CONTENT" CONTAINS "'bird'") AND (DKIKFCategory = "root/nature")
queryString
- the query string built according to the syntax described above.configuration
- the configuration for the search.DKIKFNoSuchCatalogException
- if the catalog doesn't exist in the libraryDKIKFTaxonomyNotSetException
- if the query contains a category but no taxonomy has been set in the search configurationDKIKFNoSuchCategoryException
- if the query contains a category which is not part of the taxonomy in the search configurationDKIKFQueryException
- if the query cannot be processedDKIKFAuthorizationException
- if the user or group does not have the privileges IKFRetrieveCatalog and
IKFRetrieveRecordDKIKFWebQueryConverter
public abstract DKIKFService getService()
|
IBM Information Integrator for Content V8.2 APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |