public class CompositeInstanceContext
extends java.lang.Object
A class for representing the attributes of general modules that describe the patient, study, series, instance and related "context" of the payload of a composite DICOM instance.
The purpose is to allow the context to be extracted from an existing object, stored, and then reused in new objects, either wholly or partially, by selectively removing modules for lower level information entities as appropriate. E.g.:
CompositeInstanceContext cic = new CompositeInstanceContext(srcList,false); cic.removeInstance(); cic.removeSeries(); cic.removeEquipment(); dstList.putAll(cic.getAttributeList());
Static methods are also provided for operating directly on an AttributeList
.
Modifier and Type | Class and Description |
---|---|
static class |
CompositeInstanceContext.Selector
A class to select which entities are copied or propagated or removed or not during operations on CompositeInstanceContext.
|
Modifier and Type | Field and Description |
---|---|
protected static AttributeTag[] |
clinicalTrialSubjectModuleAttributeTags |
protected static AttributeTag[] |
frameOfReferenceModuleAttributeTags |
protected static AttributeTag[] |
generalEquipmentModuleAttributeTags |
protected static AttributeTag[] |
generalImageModuleAttributeTags |
protected static AttributeTag[] |
generalSeriesModuleAttributeTags |
protected static AttributeTag[] |
generalStudyModuleAttributeTags |
protected AttributeList |
list |
protected static AttributeTag[] |
patientModuleAttributeTags |
protected static AttributeTag[] |
patientStudyModuleAttributeTags |
protected static AttributeTag[] |
sopCommonModuleAttributeTags |
protected static AttributeTag[] |
srDocumentGeneralModuleAttributeTags |
Constructor and Description |
---|
CompositeInstanceContext() |
CompositeInstanceContext(AttributeList srcList)
Deprecated.
use
CompositeInstanceContext(AttributeList,boolean) instead |
CompositeInstanceContext(AttributeList srcList,
boolean forSR)
Create the composite context module
Attribute s with values from the supplied AttributeList . |
Modifier and Type | Method and Description |
---|---|
protected void |
addOrReplaceIfNotEmptyOtherwiseLeaveUnchanged(AttributeList srcList,
AttributeTag tag) |
protected void |
createPerformedProcedureCodeSequenceIfAbsent(AttributeList srcList) |
protected void |
createReferencedRequestSequenceIfAbsent(AttributeList srcList) |
boolean |
equals(java.lang.Object o) |
AttributeList |
getAttributeList()
Return the
AttributeList of all the Attribute s in the context. |
int |
hashCode() |
void |
put(Attribute a) |
void |
putAll(AttributeList srcList) |
void |
removeAllButPatient()
See
removeAllButPatient . |
static void |
removeAllButPatient(AttributeList list)
Remove the study, series, equipment, frame of reference and instance level module
Attribute s. |
void |
removeAllButPatientAndStudy()
|
static void |
removeAllButPatientAndStudy(AttributeList list)
Remove the series, equipment, frame of reference and instance level module
Attribute s. |
static void |
removeAllButSelected(AttributeList list,
CompositeInstanceContext.Selector selector)
Remove the unselected modules
Attribute s. |
void |
removeAllButSelected(CompositeInstanceContext.Selector selector)
Remove the unselected modules
Attribute s. |
static void |
removeAllSelected(AttributeList list,
CompositeInstanceContext.Selector selector)
Remove the selected modules
Attribute s. |
void |
removeAllSelected(CompositeInstanceContext.Selector selector)
Remove the selected modules
Attribute s. |
void |
removeEquipment()
See
removeEquipment . |
static void |
removeEquipment(AttributeList list)
Remove the General Equipment module
Attribute s. |
void |
removeFrameOfReference()
|
static void |
removeFrameOfReference(AttributeList list)
Remove the Frame of Reference module
Attribute s. |
void |
removeInstance()
See
removeInstance . |
static void |
removeInstance(AttributeList list)
Remove the SOP Common and General Image module
Attribute s. |
void |
removePatient()
|
static void |
removePatient(AttributeList list)
Remove the Patient and Clinical Trial Subject module
Attribute s. |
void |
removeSeries()
See
removeSeries . |
static void |
removeSeries(AttributeList list)
Remove the General Series module
Attribute s. |
void |
removeSRDocumentGeneral()
|
static void |
removeSRDocumentGeneral(AttributeList list)
Remove the SR Document General Image module
Attribute s. |
void |
removeStudy()
See
removeStudy . |
static void |
removeStudy(AttributeList list)
Remove the General Study and Patient Study module
Attribute s. |
java.lang.String |
toString() |
void |
updateFromSource(AttributeList srcList)
Deprecated.
use
updateFromSource(AttributeList,boolean) instead |
void |
updateFromSource(AttributeList srcList,
boolean forSR)
Add or replace all of the composite context module
Attribute s with values from the supplied AttributeList . |
protected AttributeList list
protected static AttributeTag[] patientModuleAttributeTags
protected static AttributeTag[] clinicalTrialSubjectModuleAttributeTags
protected static AttributeTag[] generalStudyModuleAttributeTags
protected static AttributeTag[] patientStudyModuleAttributeTags
protected static AttributeTag[] generalSeriesModuleAttributeTags
protected static AttributeTag[] generalEquipmentModuleAttributeTags
protected static AttributeTag[] frameOfReferenceModuleAttributeTags
protected static AttributeTag[] sopCommonModuleAttributeTags
protected static AttributeTag[] generalImageModuleAttributeTags
protected static AttributeTag[] srDocumentGeneralModuleAttributeTags
public CompositeInstanceContext()
public CompositeInstanceContext(AttributeList srcList, boolean forSR)
Create the composite context module Attribute
s with values from the supplied AttributeList
.
forSR
- true if need to populate the SR Document General Module specific Attribute
s from their image equivalentssrcList
- the list of attributes to use as the sourcepublic CompositeInstanceContext(AttributeList srcList)
CompositeInstanceContext(AttributeList,boolean)
insteadCreate the composite context module Attribute
s with values from the supplied AttributeList
.
Also populates the SR Document General Module specific Attribute
s from their image equivalents.
srcList
- the list of attributes to use as the sourcepublic AttributeList getAttributeList()
Return the AttributeList
of all the Attribute
s in the context.
AttributeList
of all the Attribute
s in the contextpublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
protected void addOrReplaceIfNotEmptyOtherwiseLeaveUnchanged(AttributeList srcList, AttributeTag tag)
protected void createReferencedRequestSequenceIfAbsent(AttributeList srcList)
protected void createPerformedProcedureCodeSequenceIfAbsent(AttributeList srcList)
public void updateFromSource(AttributeList srcList, boolean forSR)
Add or replace all of the composite context module Attribute
s with values from the supplied AttributeList
.
If an Attribute
is empty or missing in the supplied list, the existing value in the context is left unchanged (not removed or emptied).
This is useful when building composite context from multiple input composite instances, in which optional Attribute
s are filled in some,
but not others, in order to accumulate the most information available.
srcList
- the list of attributes to use as the sourceforSR
- true if need to populate the SR Document General Module specific Attribute
s from their image equivalentspublic void updateFromSource(AttributeList srcList)
updateFromSource(AttributeList,boolean)
insteadAdd or replace all of the composite context module Attribute
s with values from the supplied AttributeList
.
If an Attribute
is empty or missing in the supplied list, the existing value in the context is left unchanged (not removed or emptied).
This is useful when building composite context from multiple input composite instances, in which optional Attribute
s are filled in some,
but not others, in order to accumulate the most information available.
Also populates the SR Document General Module specific Attribute
s from their image equivalents.
srcList
- the list of attributes to use as the sourcepublic static void removePatient(AttributeList list)
Remove the Patient and Clinical Trial Subject module Attribute
s.
list
- the list of attributes to editpublic static void removeAllButPatient(AttributeList list)
Remove the study, series, equipment, frame of reference and instance level module Attribute
s.
list
- the list of attributes to editpublic static void removeAllButPatientAndStudy(AttributeList list)
Remove the series, equipment, frame of reference and instance level module Attribute
s.
list
- the list of attributes to editpublic static void removeStudy(AttributeList list)
Remove the General Study and Patient Study module Attribute
s.
list
- the list of attributes to editpublic static void removeSeries(AttributeList list)
Remove the General Series module Attribute
s.
list
- the list of attributes to editpublic static void removeEquipment(AttributeList list)
Remove the General Equipment module Attribute
s.
list
- the list of attributes to editpublic static void removeFrameOfReference(AttributeList list)
Remove the Frame of Reference module Attribute
s.
list
- the list of attributes to editpublic static void removeInstance(AttributeList list)
Remove the SOP Common and General Image module Attribute
s.
list
- the list of attributes to editpublic static void removeSRDocumentGeneral(AttributeList list)
Remove the SR Document General Image module Attribute
s.
list
- the list of attributes to editpublic static void removeAllButSelected(AttributeList list, CompositeInstanceContext.Selector selector)
Remove the unselected modules Attribute
s.
list
- the list of attributes to editselector
- the modules to keeppublic static void removeAllSelected(AttributeList list, CompositeInstanceContext.Selector selector)
Remove the selected modules Attribute
s.
list
- the list of attributes to editselector
- the modules to removepublic void removePatient()
public void removeAllButPatient()
removeAllButPatient
.public void removeAllButPatientAndStudy()
public void removeStudy()
removeStudy
.public void removeSeries()
removeSeries
.public void removeEquipment()
removeEquipment
.public void removeFrameOfReference()
public void removeInstance()
removeInstance
.public void removeSRDocumentGeneral()
public void removeAllButSelected(CompositeInstanceContext.Selector selector)
Remove the unselected modules Attribute
s.
removeAllButSelected
.selector
- the modules to keeppublic void removeAllSelected(CompositeInstanceContext.Selector selector)
Remove the selected modules Attribute
s.
removeAllSelected
.selector
- the modules to removepublic void put(Attribute a)
public void putAll(AttributeList srcList)
public java.lang.String toString()
toString
in class java.lang.Object