Index

DKBlobIP

Purpose:

The DKBlobIP class represents a binary large object (BLOB) for ImagePlus for OS/390. The BLOB is an 100 megabyte document or annotation object.

The ability to add, update and delete attributes is not supported in this release.

Class summary:

class DKBlobIP : public dkBlob
{
   public:
 
      DKString dumpContent ();
      DKBlobIP (DKDatastoreIP* dsIP);
      DKBlobIP (DKDatastoreIP* dsIP, const DKString& data);
      DKBlobIP (const DKBlobIP& blob);
      virtual ~DKBlobIP ();
      virtual DKString  getObjectType () const;
      virtual void       setNull ();
      virtual DKBoolean  isNull () const;
      virtual dkXDOBase&  operator= (const dkXDOBase& xdo);
      virtual void  open ();
      virtual DKBoolean  isContentChanged () const;
      virtual DKBoolean  isSet () const;
      virtual void  setPidObject (const DKPidXDO* pid);
      virtual const DKPidXDO*  getPidObject ();
      virtual dkXDO&  add ();
      virtual dkXDO&  retrieve ();
      virtual dkXDO&  update ();
      virtual dkXDO&  del ();
      virtual dkXDO&     copyData (const dkXDO& xdo);
      virtual DKBoolean  compareData (const dkXDO& xdo);
      virtual dkXDO& cloneSkeleton ();
      virtual DKString  getContent () const;
      virtual dkXDO&    setContent (const DKString& data);
      virtual dkBlob&   getContentToClientFile (const char* fName,
                                                int fOpt) const;
      virtual dkBlob&  setContentFromClientFile (const char* fName);
      virtual dkBlob&  operator += (const dkBlob& blob);
      virtual dkBlob&  operator += (const DKString& data);
      virtual void  open (const char*  fName);
      virtual void  setClassOpenHandler (const char* hOpen,
                                         DKBoolean sysFlag);
      virtual void  setInstanceOpenHandler (const char* hOpen,
                                            DKBoolean sysFlag);
      virtual DKString   getOpenHandler ();
      virtual DKBoolean  isOpenSynchronous ();
      virtual dkBlob&  add (const char* fName);
      virtual dkBlob&  retrieve (const char* fName);
      virtual dkBlob&  update (const char* fName);
      virtual dkBlob&  del (DKBoolean flush);
      DKString       getDocId () const;
      void           setDocId (const char* itemId);
      DKBoolean      isDocIdSet() const;
      unsigned long  getPartId () const;
      void           setPartId (unsigned long partId);
       unsigned long  getContentClass ();
      void           setContentClass (unsigned long ccls);
      virtual unsigned long  getAffiliatedType ();
      virtual void           setAffiliatedType (unsigned long affType);
      virtual DKString getMimeType();
      DKString  mimeType ();
      DKString  getCreatedTimestamp ();
      DKString  getUpdatedTimestamp ();
      long  getSize ();
      virtual DKBlobIP&  operator= (const DKBlobIP& aDKBlobIP);
      virtual DKBlobIP&  operator+ (const DKBlobIP& blob) const;
      virtual DKBlobIP&  operator+ (const DKString& data) const;
      friend  DKBlobIP&  operator+ (const DKString& data,
                                    const DKBlobIP& blob);
      virtual DKBlobIP&  subLob (long startPos, long len) const;
      long  getRank ();
      void  setRank (long r);
      void  setPageCount (short  aCount);
      long  getPageCount () const;
      void  setDescription ( DKString aDesc );
      DKString getDescription() const;
      void  setDDO ( DKDDO* aDDO );
      DKDDO* getDDO() const;
      void  setDatastore ( DKDatastoreIP* aDS );
      void  addExtension (const DKString& name, const dkExtension* object);
      void  removeExtension (const DKString& name);
      void  setExtension (const DKString& name, const dkExtension* object);
      const dkExtension*  getExtension (const DKString& name);
};

Members:

Constructors and destructor
The first constructor constructs the binary large object (BLOB) and defers initialization until implementation methods are called. The second constructor constructs the BLOB and sets the object's content. The third constructor is the copy constructor.
      DKBlobIP (DKDatastoreIP* dsIP);
      DKBlobIP (DKDatastoreIP* dsIP, const DKString& data);
      DKBlobIP (const DKBlobIP& blob);
 
      virtual ~DKBlobIP ();
 

Member functions

getObjectType
Gets the object type.
  virtual DKString  getObjectType () const;
 

setNull
Sets the part content to null (in memory).
  virtual void setNull ();
 

isNull
Checks if the part content is null (in memory).
  virtual DKBoolean  isNull () const;
 

operator=
Assignment operator.
  virtual dkXDOBase&  operator= (const dkXDOBase& xdo);
 

open
Unloads the object content to a client file with a system generated name and then synchronously invokes a default handler against the file.
  virtual void  open ();
 

isContentChanged
Checks if the part content changed (in memory).
  virtual DKBoolean  isContentChanged () const;
 

isSet
Checks if the part content is set (in memory).
  virtual DKBoolean  isSet () const;
 

setPidObject
Sets the PID information of this object with the new provided PID. A copy of the PID is made, so the original PID passed in on the call should be deleted by the caller of this method.
  virtual void  setPidObject (const DKPidXDO* pid);
 

getPidObject
Gets a reference to the XDO persistent identifier (PID). The DKPidXDO reference should not be deleted by the caller of this method.
  virtual const DKPidXDO*  getPidObject ();
 

add
Adds the object content from memory to the datastore.
  virtual dkXDO&  add ();

retrieve
Retrieves the object content from a stored object distribution manager (ODM) document or annotation.
  virtual dkXDO&  retrieve ();
 

update
Updates the object content in datastore with the content in memory.

  virtual dkXDO&  update ();

del
Deletes the object content from datastore.
  virtual dkXDO&  del ();

copyData
Replaces the content of this object with the content of the specified XDO object.
  virtual dkXDO&  copyData (const dkXDO& xdo);
 

compareData
Compares the content of this object with the content of the specified XDO object.
  virtual DKBoolean  compareData (const dkXDO& xdo);
 

cloneSkeleton
Clones this extended data object (XDO) with its persistent ID only (that is, with its data content set to empty).
  virtual dkXDO& cloneSkeleton ();
 

getContent
Gets the content of this object.
  virtual DKString  getContent () const;
 

setContent
Sets the content of this object with a string argument.
  virtual dkXDO& setContent (const DKString& data);
 

getContentToClientFile
Copies the lob data of this object to the given file.
  virtual dkBlob& getContentToClientFile (const char* 
                                                  fName,int fOpt) const;
 

setContentFromClientFile
Replaces the LOB data of this object with the contents of the given file.
  virtual dkBlob&  setContentFromClientFile (const char* fName);
 

operator +=
Concatenates this object with the specified binary large object (BLOB). The results of the concatenation replaces the existing contents of this object.
  virtual dkBlob&  operator += (const dkBlob& blob);
 

operator +=
Concatenates this object with the specified string. The results of the concatenation replaces the existing contents of this object.
  virtual dkBlob&  operator += (const DKString& data);
 

open
Unloads the object content into the given file and then synchronously invokes a default handler against the file.
  virtual void  open (const char*  fName);
 

setClassOpenHandler
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object class.
  virtual void  setClassOpenHandler (const char* hOpen, 
                                     DKBoolean sysFlag);
 

setInstanceOpenHandler
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instance.
  virtual void  setInstanceOpenHandler (const char* hOpen,
                                            DKBoolean sysFlag);
 

getOpenHandler
Gets the current program name of the handler for this object instance.
  virtual DKString getOpenHandler ();
 

isOpenSynchronous
Gets the current synchronization property.
  virtual DKBoolean  isOpenSynchronous ();
 

add
Adds the object content from an existing file to the datastore.
  virtual dkBlob&  add (const char* fName);

retrieve
Retrieves the object content from the datastore into the given file.
  virtual dkBlob&  retrieve (const char* fName);
 

update
Updates the object content in datastore with a file.
  virtual dkBlob&  update (const char* fName);

del
Deletes the object content from the datastore.
  virtual dkBlob&  del (DKBoolean flush);

getDocId
Gets the document ID, which is the folder application facility (FAF) document ID.
  DKString getDocId () const;
 

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

isDocIdSet
Checks if the document ID is set.
  DKBoolean isDocIdSet() const;
 

getPartId
Gets the part id of this XDO.
  unsigned long  getPartId () const;
 

setPartId
Sets the part id of this XDO.
  void setPartId (unsigned long partId);
 

getContentClass
Gets the content class of the object.
  unsigned long  getContentClass ();
 

setContentClass
Sets the content class of the object.
  void setContentClass (unsigned long ccls);
 

getAffiliatedType
Gets the affiliated type of the object. The possible affiliated types for ImagePlus for OS/390 are DK_CM_ANNOTATION or DK_CM_BASE.
  virtual unsigned long  getAffiliatedType ();
 

setAffiliatedType
Sets the affiliated type of the object.
  virtual void setAffiliatedType (unsigned long affType);
 

getMimeType
Gets the MIME type that represents this object's contentClass.

  virtual DKString getMimeType();
 

mimeType
Gets the MIME type representing this object's contentClass.
  DKString  mimeType ();
 

getCreatedTimestamp
Gets the date & time that the object was created.
  DKString getCreatedTimestamp ();
 

getUpdatedTimestamp
Gets the date & time that the object was updated.
  DKString  getUpdatedTimestamp ();
 

getSize
Gets the size of this object without retrieving the object content.

  long  getSize ();
 

operator=
Assignment operator.
  virtual DKBlobIP&  operator= (const DKBlobIP& aDKBlobIP);
 

operator+
Concatenates this object with the specified DKBlobIP object. A new DKBlobIP object containing the result is returned.
  virtual DKBlobIP&  operator+ (const DKBlobIP& blob) const;
 

operator+
Concatenates this object with the specified string. A new DKBlobIP object containing the result is returned.
  virtual DKBlobIP&  operator+ (const DKString& data) const;
 

operator+
Concatenates the specified string with the specified DKBlobIP. A new DKBlobIP object containing the result is returned.
  friend  DKBlobIP&  operator+ (const DKString& data,
                                const DKBlobIP& blob);
 

subLob
Similar to subString, but returns the subString data in the form of a new DKBlobIP object.
  virtual DKBlobIP&  subLob (long startPos,
                             long len) const;
 

getRank
Gets the ranking value of a query.
  long  getRank ();
 

setRank
Sets the ranking value of a query.
  void  setRank (long r);
 

setPageCount
Sets the page count of the object distribution manager (ODM), represented by this binary large object (BLOB).
  void setPageCount (short aCount);
 

getPageCount
Gets the page count of the object distribution manager (ODM), represented by this binary large object (BLOB).
  long  getPageCount () const;
 

setDescription
Sets the description of this binary large object (BLOB) when this BLOB is of the type DK_CM_ANNOTATION.
  void  setDescription ( DKString aDesc );
 

getDescription
Gets the description for this binary large object (BLOB) if this BLOB's affiliated type is DK_CM_ANNOTATION.
  DKString getDescription() const;
 

setDDO
Sets a reference to the document dynamic data object (DDO) associated with this binary large object (BLOB).
  void  setDDO ( DKDDO* aDDO );
 

getDDO
Gets a reference to the document DDO associated with this binary large object (BLOB). The DKDDO reference should not be deleted by the caller of this method.
  DKDDO* getDDO() const;
 

setDatastore
Sets a reference to the owner datastore object.
  void  setDatastore ( DKDatastoreIP* aDS );
 

addExtension
Add the extension object.
  void  addExtension (const DKString& name,
                          const dkExtension* object);
 

removeExtension
Remove the extension object.
  void  removeExtension (const DKString& name);
 

setExtension
Sets the extension object.
  void  setExtension (const DKString& name,
                          const dkExtension* object);
 

getExtension
Gets a reference to the specified extension object. The dkExtension reference should not be deleted by the caller of this method.
  const dkExtension*  getExtension (const DKString& name);
 

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