org.dcm4che.srom
Interface ContainerContent

All Superinterfaces:
Content
All Known Subinterfaces:
KeyObject, SRDocument

public interface ContainerContent
extends Content

The ContainerContent interface represents a DICOM SR Container Content of value type CONTAINER.
A Container Content is used as Document Title or document section heading. Concept Name conveys the Document Title (if the CONTAINER is the Document Root Content Item) or the category of observation.

Version:
1.0
Author:
gunter.zeilinger@tiani.com
See Also:
"DICOM Part 3: Information Object Definitions, Annex C.17.3 SR Document Content Module"

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.dcm4che.srom.Content
Content.RelationType, Content.ValueType
 
Field Summary
 
Fields inherited from interface org.dcm4che.srom.Content
log
 
Method Summary
 void insertCompositeContent(Code name, SOPInstanceRef refSOP)
          Convenient method to insert a new Composite Content Item into this container and add the SOP instance reference into the Current Requested Procedure Evidence Sequence.
 void insertImageContent(Code name, SOPInstanceRef refSOP, int[] frameNumbers, SOPInstanceRef refPresentationSOP, IconImage iconImage)
          Convenient method to insert a new Image Content Item into this container and add the SOP instance reference of the image and the presentation state SOP instance reference into the Current Requested Procedure Evidence Sequence.
 void insertWaveformContent(Code name, SOPInstanceRef refSOP, int[] channelNumbers)
          Convenient method to insert a new Waveform Conten Item into this container and add the SOP instance reference into the Current Requested Procedure Evidence Sequence.
 boolean isSeparate()
          Spefifies whether Content Items are logically linked.
 void setSeparate(boolean separate)
           
 
Methods inherited from interface org.dcm4che.srom.Content
appendChild, clone, getFirstChild, getFirstChildBy, getID, getLastChild, getName, getNextSibling, getNextSiblingBy, getObservationDateTime, getOwnerDocument, getParent, getPreviousSibling, getRelationType, getTemplate, getValueType, hasChildren, insertBefore, removeChild, replaceChild, setName, toDataset
 

Method Detail

isSeparate

boolean isSeparate()
Spefifies whether Content Items are logically linked.
DICOM Tag: (0040,A050)
Tag Name: Continuity of Content
This flag specifies whether or not its contained Content Items are logically linked in a continuous textual flow, or are separate items.

Returns:
true if Continuity of Content has value SEPARATE or false if it has value CONTINUOUS
See Also:
"DICOM Part 3: Information Object Definitions, Annex C.17.3.2 Continuity of Content"

setSeparate

void setSeparate(boolean separate)

insertCompositeContent

void insertCompositeContent(Code name,
                            SOPInstanceRef refSOP)
Convenient method to insert a new Composite Content Item into this container and add the SOP instance reference into the Current Requested Procedure Evidence Sequence. Particularly useful for construction of Key Object Selection Documents.

Parameters:
name - Concept Name Code or null.
refSOP - the SOP instance reference.

insertImageContent

void insertImageContent(Code name,
                        SOPInstanceRef refSOP,
                        int[] frameNumbers,
                        SOPInstanceRef refPresentationSOP,
                        IconImage iconImage)
Convenient method to insert a new Image Content Item into this container and add the SOP instance reference of the image and the presentation state SOP instance reference into the Current Requested Procedure Evidence Sequence. Particularly useful for construction of Key Object Selection Documents.

Parameters:
name - Concept Name Code or null.
refSOP - the SOP instance reference of the referenced image.
frameNumbers - the references frame numbers of a multiframe image.
refPresentationSOP - the SOP instance reference of the referenced presentation state.
iconImage - Icon Image or null.

insertWaveformContent

void insertWaveformContent(Code name,
                           SOPInstanceRef refSOP,
                           int[] channelNumbers)
Convenient method to insert a new Waveform Conten Item into this container and add the SOP instance reference into the Current Requested Procedure Evidence Sequence. Particularly useful for construction of Key Object Selection Documents.

Parameters:
name - Concept Name Code or null.
refSOP - the SOP instance reference of the referenced Wavoform.
channelNumbers - the referenced channel numbers.