|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.beans.CMBAnnotation
This is a helper class for the CMBDataManagement bean. This class provides functions for manipulation of annotation data.
CMBDataManagement
, Serialized FormField Summary | |
static int |
CMB_ANNOTATION_TYPE_BINARY
Constant indicating that the annotation is binary (non-character) data. |
static int |
CMB_ANNOTATION_TYPE_STRING
Constant indicating that the annotation is a character string. |
Constructor Summary | |
CMBAnnotation()
Default constructor |
|
CMBAnnotation(byte[] data,
int type)
Constructs a new CMBAnnotation object with initial data and type. |
|
CMBAnnotation(byte[] data,
int type,
java.lang.String dsType)
Constructs a new CMBAnnotation object with initial data and type, and datastore type. |
|
CMBAnnotation(java.lang.String data,
java.lang.String dsType)
Constructs a new CMBAnnotation object with initial annotation string and datastore type. |
Method Summary | |
boolean |
equals(CMBAnnotation anAnnoObj)
Compares this object with the parameter object. |
protected com.ibm.mm.sdk.common.dkAnnotationExt |
getAnnoObj()
Gets the API annotation object. |
int |
getAnnotationType()
Gets annotation type |
byte[] |
getByteArrayData()
Gets the annotation in byte arrary format |
char |
getColor()
Gets the color setting of the annotation. |
CMBObject |
getComplexData()
Gets annotation object |
java.io.InputStream |
getDataStream()
Returns a stream to the annotation data. |
java.lang.String |
getGroupName()
Gets the group name setting of the annotation. |
int |
getId()
Gets the part Id of the associated object |
java.lang.String |
getMimeType()
Returns the MIME content type of the annotation. |
int |
getPageNumber()
Gets the page number that this annotation object refers to. |
java.lang.String |
getStringData()
Gets annotation string |
java.lang.String |
getTimestamp()
Gets the timestamp of the annotation. |
java.lang.String |
getUserID()
Gets the userid associated with this annotation (owner's of the annotation). |
short |
getX()
Gets the X coordinate on the page that this annotation object refers to. |
protected com.ibm.mm.sdk.common.dkXDO |
getXDO()
Gets the XDO for this annotation |
short |
getY()
Gets the Y coordinate on the page that this annotation object refers to. |
boolean |
isOkToCopy()
Gets the OkToCopy setting of the annotation. |
boolean |
isPublic()
Gets the public setting of the annotation. |
protected void |
setAnnoObj(com.ibm.mm.sdk.common.dkAnnotationExt annoObj)
Sets the API annotation object |
void |
setAnnotationType(int type)
Sets annotation type |
void |
setByteArrayData(byte[] data)
Sets the annotation in byte array format |
void |
setColor(char color)
Sets the color setting of the annotation. |
void |
setComplexData(CMBObject dataObj)
Sets annotation object, will set the annotation type to CMB_ANNOTATION_TYPE_BINARY |
void |
setGroupName(java.lang.String groupName)
Sets the group name setting of the annotation. |
void |
setId(int aPartId)
Sets the part Id of the associated object, only positive values are valid. |
void |
setMimeType(java.lang.String mimetype)
Sets the MIME content type of the annotation. |
void |
setOkToCopy(boolean isOkToCopy)
Sets the OkToCopy setting of the annotation. |
void |
setPageNumber(int aPageNumber)
Sets the page number that this annotation object refers to. |
void |
setPublic(boolean isPublic)
Sets the public setting of the annotation. |
void |
setStringData(java.lang.String data)
Sets annotation string,will set the annotation type to CMB_ANNOTATION_TYPE_STRING. |
void |
setTimestamp(java.lang.String timestamp)
Sets the timestamp of the annotation. |
void |
setX(short aXcoordinate)
Sets the X coordinate on the page that this annotation object refers to. |
void |
setY(short aYcoordinate)
Sets the Y coordinate on the page that this annotation object refers to. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int CMB_ANNOTATION_TYPE_STRING
public static final int CMB_ANNOTATION_TYPE_BINARY
Constructor Detail |
public CMBAnnotation()
public CMBAnnotation(byte[] data, int type)
data
- annotation datatype
- annotation typepublic CMBAnnotation(byte[] data, int type, java.lang.String dsType)
data
- annotation datatype
- annotation typedsType
- datastore typepublic CMBAnnotation(java.lang.String data, java.lang.String dsType)
data
- annotation stringdsType
- datastore typeMethod Detail |
public int getPageNumber()
public void setPageNumber(int aPageNumber)
aPageNumber
- a page numberpublic void setMimeType(java.lang.String mimetype) throws CMBException
public java.lang.String getMimeType() throws CMBException
public short getX()
public void setX(short aXcoordinate)
aXcoordinate
- X coordinatepublic short getY()
public void setY(short aYcoordinate)
aYcoordinate
- Y coordinatepublic java.lang.String getStringData() throws CMBException
public void setStringData(java.lang.String data)
data
- annotation stringpublic CMBObject getComplexData() throws CMBException
public void setComplexData(CMBObject dataObj)
dataObj
- annotation objectpublic int getAnnotationType()
public void setAnnotationType(int type)
type
- annotation typepublic byte[] getByteArrayData() throws java.lang.Exception
java.lang.Exception
- public java.io.InputStream getDataStream() throws java.lang.Exception
public void setByteArrayData(byte[] data)
data
- view datapublic java.lang.String getUserID()
public int getId()
public void setId(int aPartId)
aPartId
- a part Idpublic java.lang.String getTimestamp()
public void setTimestamp(java.lang.String timestamp)
public boolean isPublic()
public void setPublic(boolean isPublic)
public char getColor()
public void setColor(char color)
public java.lang.String getGroupName()
public void setGroupName(java.lang.String groupName)
public boolean isOkToCopy()
public void setOkToCopy(boolean isOkToCopy)
public boolean equals(CMBAnnotation anAnnoObj)
anAnnoObj
- the second object to comparepublic java.lang.String toString()
toString
in class java.lang.Object
protected void setAnnoObj(com.ibm.mm.sdk.common.dkAnnotationExt annoObj)
annoObj
- an instance of dkAnnotationExtprotected com.ibm.mm.sdk.common.dkAnnotationExt getAnnoObj()
protected com.ibm.mm.sdk.common.dkXDO getXDO()
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |