Index

DKPidXDODES

Purpose:

The DKPidXDODES class defines the persistent identifier (PID) for a DES BLOB (XDO). The primary ID in this PID is made up of databaseName|documentId; that is, the databaseName followed by the character '|' followed by the documentId.

Class summary:

class DKPidXDODES : public DKPidXDO
{
public:
    DKPidXDODES();
    DKPidXDODES(const char * aPidString);
    DKPidXDODES(const DKPidXDODES& aDKPidXDODES);
    virtual ~DKPidXDODES();
 
    virtual DKString  getId() const;
    virtual void      setId(const char* fromId);
    virtual DKString  getPrimaryId();
    virtual void      setPrimaryId(const char* primaryId);
    virtual DKBoolean isSet() const;
    DKString          getDatabaseName();
    void              setDatabaseName(const char* pszDBName );
    DKString          getDocId();
    void              setDocId(const char* pszDocId );
    DKString          getFieldName();
    void              setFieldName(const char* fieldName);
    DKBoolean         operator==(const DKPidXDODES&);
 
    virtual DKPid*    clone();
    virtual DKString  pidType() const;
};

Members:

Constructors and destructor

Parameters
aPidString -- The persistent identifier (PID) string.
aDKPidXDODES -- An extended data object (XDO) PID for Extended Search (DES).

    DKPidXDODES();
    DKPidXDODES(const char * aPidString);
    DKPidXDODES(const DKPidXDODES& aDKPidXDODES);
    virtual ~DKPidXDODES();
 

Member functions

getID
getId has been deprecated and replaced by getPrimaryId.
    virtual DKString  getId() const;
 

setID
setId has been deprecated and replaced by setPrimaryId.
    virtual void setId(const char* fromId);
 

getPrimaryId
Gets the primary ID.
    virtual DKString  getPrimaryId();
 

setPrimaryId
Sets the primary ID.
    virtual void setPrimaryId(const char* primaryId);
 

isSet
Checks to see if the persistent identifier (PID) values indicators are set.
    virtual DKBoolean isSet() const;
 

getDatabaseName
Gets the database name.
    DKString getDatabaseName();
 

setDatabaseName
Sets the database name.
    void setDatabaseName(const char* pszDBName );
 

getDocId
Gets the document ID.
    DKString getDocId();
 

setDocId
Sets the document ID.
    void setDocId(const char* pszDocId );
 

getFieldName
Gets the field name.
    DKString getFieldName();
 

setFieldName
Sets the field name.
    void setFieldName(const char* fieldName);
 

operator==
Compares this object with the specified object.
    DKBoolean operator==(const DKPidXDODES&);
 

clone
Gets a copy of the persistent identifier (PID).
    virtual DKPid* clone();
 

pidType
Gets the persistent identifier (PID) type.
    virtual DKString  pidType() const;
 

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.