cdac.medinfo.sdk.dcm30_04.baselibs

Class TextObjectSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.TextObjectSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class TextObjectSequenceItem
extends Item

Sequence that describes a text annotation

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
float[]	getAnchorPoint() Retrieves Location of a point in the image or Specified Displayed Area to which the Unformatted Text Value is related.
java.lang.String	getAnchorPointAnnotationUnits() Retrieves Units of measure for the axes of the text anchor point annotation
java.lang.String	getAnchorPointVisibility() Retrieves Flag to indicate whether or not a visible indication of the relationship between the text and the anchor point is to be displayed.
java.lang.String	getBoundingBoxAnnotationUnits() Retrieves Units of measure for the axes of the text bounding box.
float[]	getBoundingBoxBottomRightHandCorner() Retrieves the Bottom Right pixel in the referenced image to be displayed, given as column\row.
java.lang.String	getBoundingBoxTextHorizontalJustification() Retrieves Location of the text relative to the vertical edges of the bounding box.
float[]	getBoundingBoxTopLeftHandCorner() Retrieves the top left pixel in the referenced image to be displayed, given as column\row.
java.lang.String	getUnformattedTextValue() Retrieves Text data which is unformatted and whose manner of display within the defined bounding box or relative to the specified anchor point is implementation dependent.
void	setAnchorPoint(float[] arrfAnchorPoint) Sets Location of a point in the image or Specified Displayed Area to which the Unformatted Text Value is related.
void	setAnchorPointAnnotationUnits(EnumBoundingBoxAnnotationUnits enumAnchorPointAnnotationUnits) Sets Units of measure for the axes of the text anchor point annotation
void	setAnchorPointVisibility(EnumAnchorPointVisibility enumAnchorPointVisibility) Sets Flag to indicate whether or not a visible indication of the relationship between the text and the anchor point is to be displayed.
void	setBoundingBoxAnnotationUnits(EnumBoundingBoxAnnotationUnits enumBoundingBoxAnnotationUnits) Sets Units of measure for the axes of the text bounding box.
void	setBoundingBoxBottomRightHandCorner(float[] arrfBoundingBoxBottomRightHandCorner) Sets Location of the Bottom Right Hand Corner of the bounding box in which Unformatted Text Value is to be displayed, in Bounding Box Annotation Units , given as column\row.
void	setBoundingBoxTextHorizontalJustification(EnumBoundingBoxTextHorizontalJustification enumBoundingBoxTextHorizontalJustification) Sets Location of the text relative to the vertical edges of the bounding box.
void	setBoundingBoxTopLeftHandCorner(float[] arrfBoundingBoxTopLeftHandCorner) Sets Location of the Top Left Hand Corner of the bounding box in which Unformatted Text Value is to be displayed, in Bounding Box Annotation Units , given as column\row.
void	setUnformattedTextValue(java.lang.String strUnformattedTextValue) Sets Text data which is unformatted and whose manner of display within the defined bounding box or relative to the specified anchor point is implementation dependent.
boolean	validateForModule() Validates all the attributes in TextObjectSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in TextObjectSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setBoundingBoxAnnotationUnits

public void setBoundingBoxAnnotationUnits(EnumBoundingBoxAnnotationUnits enumBoundingBoxAnnotationUnits)

Sets Units of measure for the axes of the text bounding box.

Parameters:

enumBoundingBoxAnnotationUnits - Enum value of Units

getBoundingBoxAnnotationUnits

public java.lang.String getBoundingBoxAnnotationUnits()

Retrieves Units of measure for the axes of the text bounding box.

Returns:

String - value of Units.

setAnchorPointAnnotationUnits

public void setAnchorPointAnnotationUnits(EnumBoundingBoxAnnotationUnits enumAnchorPointAnnotationUnits)

Sets Units of measure for the axes of the text anchor point annotation

Parameters:

enumAnchorPointAnnotationUnits - Enum value of Units

getAnchorPointAnnotationUnits

public java.lang.String getAnchorPointAnnotationUnits()

Retrieves Units of measure for the axes of the text anchor point annotation

Returns:

String - value of Units.

setUnformattedTextValue

public void setUnformattedTextValue(java.lang.String strUnformattedTextValue)

Sets Text data which is unformatted and whose manner of display within the defined bounding box or relative to the specified anchor point is implementation dependent.

Parameters:

strUnformattedTextValue - String value of Text Data

getUnformattedTextValue

public java.lang.String getUnformattedTextValue()

Retrieves Text data which is unformatted and whose manner of display within the defined bounding box or relative to the specified anchor point is implementation dependent.

Returns:

String - value of Text Data

setBoundingBoxTopLeftHandCorner

public void setBoundingBoxTopLeftHandCorner(float[] arrfBoundingBoxTopLeftHandCorner)

Sets Location of the Top Left Hand Corner of the bounding box in which Unformatted Text Value is to be displayed, in Bounding Box Annotation Units , given as column\row.

Parameters:

arrfBoundingBoxTopLeftHandCorner - float array of Hand Corner of the bounding box

getBoundingBoxTopLeftHandCorner

public float[] getBoundingBoxTopLeftHandCorner()

Retrieves the top left pixel in the referenced image to be displayed, given as column\row.

Returns:

float[] - float array of Hand Corner of the bounding box

setBoundingBoxBottomRightHandCorner

public void setBoundingBoxBottomRightHandCorner(float[] arrfBoundingBoxBottomRightHandCorner)

Sets Location of the Bottom Right Hand Corner of the bounding box in which Unformatted Text Value is to be displayed, in Bounding Box Annotation Units , given as column\row.

Parameters:

arrfBoundingBoxBottomRightHandCorner - float array of Hand Corner of the bounding box

getBoundingBoxBottomRightHandCorner

public float[] getBoundingBoxBottomRightHandCorner()

Retrieves the Bottom Right pixel in the referenced image to be displayed, given as column\row.

Returns:

float[] - float array of Hand Corner of the bounding box

setBoundingBoxTextHorizontalJustification

public void setBoundingBoxTextHorizontalJustification(EnumBoundingBoxTextHorizontalJustification enumBoundingBoxTextHorizontalJustification)

Sets Location of the text relative to the vertical edges of the bounding box.

Parameters:

enumBoundingBoxTextHorizontalJustification - Enum value of Location

getBoundingBoxTextHorizontalJustification

public java.lang.String getBoundingBoxTextHorizontalJustification()

Retrieves Location of the text relative to the vertical edges of the bounding box.

Returns:

String - value of Location

setAnchorPoint

public void setAnchorPoint(float[] arrfAnchorPoint)

Sets Location of a point in the image or Specified Displayed Area to which the Unformatted Text Value is related.

Parameters:

arrfAnchorPoint - float array of Location of a point

getAnchorPoint

public float[] getAnchorPoint()

Retrieves Location of a point in the image or Specified Displayed Area to which the Unformatted Text Value is related.

Returns:

float[] - float array of Location of a point

setAnchorPointVisibility

public void setAnchorPointVisibility(EnumAnchorPointVisibility enumAnchorPointVisibility)

Sets Flag to indicate whether or not a visible indication of the relationship between the text and the anchor point is to be displayed.

Parameters:

enumAnchorPointVisibility - Enum value of Flag

getAnchorPointVisibility

public java.lang.String getAnchorPointVisibility()

Retrieves Flag to indicate whether or not a visible indication of the relationship between the text and the anchor point is to be displayed.

Returns:

String - value of Flag.