Purpose:
DKDatastoreDES is the specific version of dkDatastore that is used to implement the Extended Search (DES) datastore. It provides Documents, Parts, and Folders' storage-and-retrieval mechanisms. It also searches and provides other document processing capabilities supported by DES.
Class summary:
class DKDatastoreDES : public dkDatastore { public: DKDatastoreDES(); DKDatastoreDES(const char* configuration); virtual ~DKDatastoreDES(); virtual void connect(const char* datastore_name, const char* user_name = "", const char* authentication = "", const char* connect_string = ""); virtual void disconnect(); virtual void getOption(long option, DKAny& value); virtual void setOption(long option, DKAny& value); virtual DKAny evaluate(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms = 0); virtual DKAny evaluate(dkQuery* query); virtual DKAny evaluate(DKCQExpr* qe); virtual dkResultSetCursor* execute(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms = 0); virtual dkResultSetCursor* execute(dkQuery* query); virtual dkResultSetCursor* execute(DKCQExpr* qe); virtual void executeWithCallback(const char* command, const short commandLangType, const DKNVPair* parms, dkCallback* callbackObj); virtual void executeWithCallback(dkQuery* query, dkCallback* callbackObj); virtual void executeWithCallback(DKCQExpr* qe, dkCallback* callbackObj); virtual dkQuery* createQuery(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms=0); virtual dkQuery* createQuery(DKCQExpr* qe); virtual void addObject(dkDataObject* dataobj); virtual void deleteObject(dkDataObject* dataobj); virtual void retrieveObject(dkDataObject* dataobj); virtual void updateObject(dkDataObject* dataobj); virtual void commit (); virtual void rollback (); virtual DKBoolean isConnected(); virtual DKHandle* connection(); virtual DKHandle* handle(const char* type); virtual dkCollection* listDataSources(); virtual DKString* listDataSourceNames(long& arrarySize); virtual dkCollection* listEntities(); virtual DKString* listEntityNames(long& arraySize); virtual dkCollection* listEntityAttrs(const char* entityName); virtual DKString* listEntityAttrNames(const char* entityName, long& arraySize); virtual dkDatastoreDef* datastoreDef(); virtual DKString registerMapping(DKNVPair* sourceMap); virtual void unRegisterMapping(const char* mappingName); virtual DKString* listMappingNames(long& arraySize); virtual dkSchemaMapping* getMapping(const char* mappingName); virtual dkExtension* getExtension(const char* extensionName); virtual void addExtension(const char* extensionName, dkExtension* extensionObj); virtual void removeExtension(const char* extensionName); virtual DKString* listExtensionNames(long& arraySize); virtual DKDDO* createDDO(const char* objectType, long Flags); virtual DKCQExpr* translate(DKCQExpr* cqe); virtual DKAny listServers(); virtual DKAny listSchema(); virtual DKAny listSchemaAttributes(const char* schemaEntry); void setSearchOptions(int iSourceMaxHits, int iTotalMaxHits, int iPageSize, int iGetPage, int iTimeOut, bool bScheduled, bool bResultsWhenAvail, bool bSortAscending, bool bFindAllWords, const char* sMailTo, const char* sSearchId, const char* sSortField, void *vpConstraints = NULL) void printSearchOptions(void) void setLocaleForDES(char *locale) };
Members:
DKDatastoreDES(); virtual ~DKDatastoreDES();
Parameters
virtual void connect(const char* datastore_name, const char* user_name = "", const char* authentication = "", const char* connect_string = "");
virtual void disconnect();
Parameters
option -- The option ID.
virtual void getOption(long option, DKAny& value);
Parameters
option -- The option ID
value -- The option value.
virtual void setOption(long option, DKAny& value);
Parameters
command -- A query string.
commandLangType -- A query type.
parms -- Additional query option(s) in a name/value pair.
virtual DKAny evaluate(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms = 0);
Parameters
query -- A query object.
virtual DKAny evaluate(dkQuery* query);
Parameters
qe -- A common query expression object.
virtual DKAny evaluate(DKCQExpr* qe);
Parameters
command -- A query string.
commandLangType -- A query type.
parms -- Additional query option(s) in name/value pair.
virtual dkResultSetCursor* execute(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms = 0);
Parameters
query -- A query object.
virtual dkResultSetCursor* execute(dkQuery* query);
Parameters
qe -- A common query expression object.
virtual dkResultSetCursor* execute(DKCQExpr* qe);
Parameters
command -- A query string.
commandLangType -- A query type.
parms -- Additional query option(s) in a name/value pair.
callbackObj -- A dkCallback object.
virtual void executeWithCallback(const char* command, const short commandLangType, const DKNVPair* parms, dkCallback* callbackObj);
Parameters
query -- A query object.
callbackObj -- A dkCallback object.
virtual void executeWithCallback(dkQuery* query, dkCallback* callbackObj);
Parameters
qe -- A common query expression object.
callbackObj --A dkCallback object.
virtual void executeWithCallback(DKCQExpr* qe, dkCallback* callbackObj);
Parameters
command -- A query string.
commandLangType -- A query type.
parms -- Additional query option(s) in a name/value pair.
virtual dkQuery* createQuery(const char* command, const short commandLangType = DK_DES_GQL_QL_TYPE, const DKNVPair* parms=0);
Parameters
qe -- A common query expression object.
virtual dkQuery* createQuery(DKCQExpr* qe);
virtual void addObject(dkDataObject* dataobj);
virtual void deleteObject(dkDataObject* dataobj);
Parameters
dataobj -- The data-object to be retrieved from this datastore.
virtual void retrieveObject(dkDataObject* dataobj);
virtual void updateObject(dkDataObject* dataobj);
virtual void commit ();
virtual void rollback ();
virtual DKBoolean isConnected();
virtual DKHandle* connection();
Parameters
type -- The type of handle (either session or broker).
virtual DKHandle* handle(const char* type);
virtual dkCollection* listDataSources();
virtual DKString* listDataSourceNames(long& arrarySize);
virtual dkCollection* listEntities();
virtual DKString* listEntityNames(long& arraySize);
Parameters
entityName -- The name of the entity to retrieve attributes for.
virtual dkCollection* listEntityAttrs(const char* entityName);
Parameters
entityName -- Name of the entity to retrieve attribute names for.
virtual DKString* listEntityAttrNames(const char* entityName, long& arraySize);
virtual dkDatastoreDef* datastoreDef();
Parameters
virtual DKString registerMapping(DKNVPair* sourceMap);
Parameters
mappingName -- The name of the mapping information.
virtual void unRegisterMapping(const char* mappingName);
virtual DKString* listMappingNames(long& arraySize);
Parameters
mappingName -- The name of the mapping information.
virtual dkSchemaMapping* getMapping(const char* mappingName);
Parameters
extensionName -- The name of the extension object.
virtual dkExtension* getExtension(const char* extensionName);
Parameters
extensionName -- The name of a new extension object.
extensionObj -- The extension object to be set.
virtual void addExtension(const char* extensionName, dkExtension* extensionObj);
Parameters
extensionName -- Name of the extension object to be removed.
virtual void removeExtension(const char* extensionName);
virtual DKString* listExtensionNames(long& arraySize);
virtual DKDDO* createDDO(const char* objectType, long Flags);
Parameters
cqe -- The input compound query expression.
virtual DKCQExpr* translate(DKCQExpr* cqe);
virtual DKAny listServers();
virtual DKAny listSchema();
virtual DKAny listSchemaAttributes(const char* schemaEntry);
Parameters
void setSearchOptions(int iSourceMaxHits, int iTotalMaxHits, int iPageSize, int iGetPage, int iTimeOut, bool bScheduled, bool bResultsWhenAvail, bool bSortAscending, bool bFindAllWords, const char* sMailTo, const char* sSearchId, const char* sSortField, void *vpConstraints = NULL)
void printSearchOptions(void)
Parameters
char* locale -- the locale string for the esBroker.
The following are the syntax for the locale for English(USA):
Please follow these rules for other languages supported by DES3.0.
void setLocaleForDES(char *locale)
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.