org.dcm4che.srom
Interface KeyObject

All Superinterfaces:

ContainerContent, Content

All Known Subinterfaces:

SRDocument

public interface KeyObject
extends ContainerContent

The KeyObject interface represents a DICOM Key Object Selection Document.
The Key Object Selection Document is intended for flagging one or more significant images, waveforms, or other composite SOP Instances.

Version:

0.9.9

Author:

gunter.zeilinger@tiani.com

See Also:

"DICOM Part 3: Information Object Definitions, Annex A.35.4 Key Object Selection Document Information Object Definition", "DICOM Part 3: Information Object Definitions, Annex C.17.6 Key Object Selection Modules"

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

boolean	addCurrentEvidence(SOPInstanceRef ref) Adds a new SOPInstanceRef object, refering a Current Requested Procedure Evidence of this document.
boolean	addIdenticalDocument(SOPInstanceRef ref) Adds a new SOPInstanceRef object, refering a Identical Document of this document.
boolean	addRequest(Request request) Adds a new Request object, identifing a Requested Procedure which is being fulfilled by creation of this document.
TCoordContent.Begin	createBeginTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.Begin with specified properties.
SCoordContent.Circle	createCircleSCoordContent(java.util.Date obsDateTime, Template template, Code name, float[] graphicData) Creates new SCoordContent.Circle with specified properties.
CodeContent	createCodeContent(java.util.Date obsDateTime, Template template, Code name, Code code) Creates new CodeContent with specified properties.
CompositeContent	createCompositeContent(java.util.Date obsDateTime, Template template, Code name, RefSOP refSOP) Creates new CompositeContent with specified properties.
ContainerContent	createContainerContent(java.util.Date obsDateTime, Template template, Code name, boolean separate) Creates new ContainerContent with specified properties.
DateContent	createDateContent(java.util.Date obsDateTime, Template template, Code name, java.util.Date date) Creates new DateContent with specified properties.
DateTimeContent	createDateTimeContent(java.util.Date obsDateTime, Template template, Code name, java.util.Date dateTime) Creates new TimeContent with specified properties.
SCoordContent.Ellipse	createEllipseSCoordContent(java.util.Date obsDateTime, Template template, Code name, float[] graphicData) Creates new SCoordContent.Ellipse with specified properties.
TCoordContent.End	createEndTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.End with specified properties.
ImageContent	createImageContent(java.util.Date obsDateTime, Template template, Code name, RefSOP refSOP, int[] frameNumbers, RefSOP refPresentationSOP, IconImage iconImage) Creates new ImageContent with specified properties.
SCoordContent.MultiPoint	createMultiPointSCoordContent(java.util.Date obsDateTime, Template template, Code name, float[] graphicData) Creates new SCoordContent.MultiPoint with specified properties.
TCoordContent.MultiPoint	createMultiPointTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.MultiPoint with specified properties.
TCoordContent.MultiSegment	createMultiSegmentTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.MultiSegment with specified properties.
NumContent	createNumContent(java.util.Date obsDateTime, Template template, Code name, float value, Code unit) Creates new NumContent with specified properties.
NumContent	createNumContent(java.util.Date obsDateTime, Template template, Code name, java.lang.Float value, Code unit, Code qualifier) Creates new NumContent with specified properties.
PNameContent	createPNameContent(java.util.Date obsDateTime, Template template, Code name, java.lang.String pname) Creates new PNameContent with specified properties.
SCoordContent.Point	createPointSCoordContent(java.util.Date obsDateTime, Template template, Code name, float[] graphicData) Creates new SCoordContent.Point with specified properties.
TCoordContent.Point	createPointTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.Point with specified properties.
SCoordContent.Polyline	createPolylineSCoordContent(java.util.Date obsDateTime, Template template, Code name, float[] graphicData) Creates new SCoordContent.Polyline with specified properties.
ReferencedContent	createReferencedContent(Content refContent) Creates new ReferencedContent which refers the specified Content.
ReferencedContent	createReferencedContent(int[] refContentId) Creates new ReferencedContent which refers the specified Content.
TCoordContent.Segment	createSegmentTCoordContent(java.util.Date obsDateTime, Template template, Code name, TCoordContent.Positions positions) Creates new TCoordContent.Segment with specified properties.
TextContent	createTextContent(java.util.Date obsDateTime, Template template, Code name, java.lang.String text) Creates new TextContent with specified properties.
TimeContent	createTimeContent(java.util.Date obsDateTime, Template template, Code name, java.util.Date time) Creates new TimeContent with specified properties.
UIDRefContent	createUIDRefContent(java.util.Date obsDateTime, Template template, Code name, java.lang.String uid) Creates new UIDRefContent with specified properties.
WaveformContent	createWaveformContent(java.util.Date obsDateTime, Template template, Code name, RefSOP refSOP, int[] channelNumbers) Creates new WaveformContent with specified properties.
SOPInstanceRef	findCurrentEvidence(RefSOP refSOP) Returns SOPInstanceRef objects, refering the specified Current Requested Procedure Evidence.
Content	getContent(int[] id) Returns Content with specified Content Item Identifier.
java.util.Date	getContentDateTime() Returns Content DateTime of this document.
SOPInstanceRef[]	getCurrentEvidence() Returns array of SOPInstanceRef objects, refering all Current Requested Procedure Evidences of this document.
Equipment	getEquipment() Returns Equipment contained in this document.
SOPInstanceRef[]	getIdenticalDocuments() Returns array of SOPInstanceRef objects, refering all Identical Documents of this document.
java.util.Date	getInstanceCreationDateTime() Returns Instance Creation DateTime of this document.
java.lang.String	getInstanceCreatorUID() Returns Instance Creator UID of this document.
int	getInstanceNumber() Returns Instance Number of this document.
Patient	getPatient() Returns Patient contained in this document.
Request[]	getRequests() Returns array of Request objects, identifing Requested Procedures which are being fulfilled by creation of this document.
Series	getSeries() Returns Series contained in this document.
java.lang.String	getSOPClassUID() Returns SOP Class UID of this document.
java.lang.String	getSOPInstanceUID() Returns SOP Instance UID of this document.
java.lang.String	getSpecificCharacterSet() Returns Specific Character Set for data values of this document.
Study	getStudy() Returns Study contained in this document.
Content	importContent(Content importedContent, boolean deep) Imports content from another document to this document.
boolean	removeCurrentEvidence(RefSOP ref) Removes the specified SOPInstanceRef object, from the list of Current Requested Procedure Evidences of this document.
boolean	removeIdenticalDocument(RefSOP ref) Removes the specified SOPInstanceRef object, from the list of Predecessor Document of this document.
boolean	removeRequest(Request request) Removes the specified Request object, from the list of Requested Procedures of this document.
void	setContentDateTime(java.util.Date dateTime) Sets Content DateTime of this document.
void	setCurrentEvidence(SOPInstanceRef[] refs) Sets array of SOPInstanceRef objects, refering all Current Requested Procedure Evidences of this document.
void	setEquipment(Equipment newEquipment) Replaces Equipment contained in this document by newEquipment.
void	setIdenticalDocuments(SOPInstanceRef[] refs) Sets array of SOPInstanceRef objects, refering all Identical Documents of this document.
void	setInstanceCreationDateTime(java.util.Date dateTime) Sets Instance Creation DateTime of this document.
void	setInstanceCreatorUID(java.lang.String uid) Sets Instance Creator UID of this document.
void	setInstanceNumber(int no) Sets Instance Number of this document.
void	setPatient(Patient newPatient) Replaces Patient contained in this document by newPatient.
void	setRequests(Request[] requests) Sets array of Request objects, identifing Requested Procedures which are being fulfilled by creation of this document.
void	setSeries(Series newSeries) Replaces Series contained in this document by newSeries.
void	setSOPInstanceUID(java.lang.String newSOPInstanceUID) Sets new SOP Instance UID of this document.
void	setSpecificCharacterSet(java.lang.String charset) Sets Specific Character Set for data values of this document.
void	setStudy(Study newStudy) Replaces Study contained in this document by newStudy.
Dataset	toDataset()

Methods inherited from interface org.dcm4che.srom.ContainerContent

insertCompositeContent, insertImageContent, insertWaveformContent, isSeparate, setSeparate

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

getPatient

Patient getPatient()

Returns Patient contained in this document.

Returns:

Patient contained in this document.

setPatient

void setPatient(Patient newPatient)

Replaces Patient contained in this document by newPatient.

Parameters:

newPatient - new Patient.

See Also:

SRDocumentFactory.newPatient(java.lang.String, java.lang.String, org.dcm4che.srom.Patient.Sex, java.util.Date)

getStudy

Study getStudy()

Returns Study contained in this document.

Returns:

Study contained in this document.

setStudy

void setStudy(Study newStudy)

Replaces Study contained in this document by newStudy.

Parameters:

newStudy - new Study.

See Also:

SRDocumentFactory.newStudy(java.lang.String, java.lang.String, java.util.Date, java.lang.String, java.lang.String, java.lang.String, org.dcm4che.srom.Code[])

getSeries

Series getSeries()

Returns Series contained in this document.

According DICOM, you shall set a new Series and SOP Instance UID of the document, when changing the Study.

Returns:

Series contained in this document.

setSeries

void setSeries(Series newSeries)

Replaces Series contained in this document by newSeries.

According DICOM, you shall set a new SOP Instance UID of the document, when changing the Series.

Parameters:

newSeries - new Series.

Throws:

java.lang.IllegalArgumentException - if Modality is not "SR".

See Also:

SRDocumentFactory.newSeries(java.lang.String, java.lang.String, int, org.dcm4che.srom.RefSOP)

getEquipment

Equipment getEquipment()

Returns Equipment contained in this document. The Equipment is backed by this document, so changes to this Equipment are reflected in the document.

Returns:

Equipment contained in this document.

setEquipment

void setEquipment(Equipment newEquipment)

Replaces Equipment contained in this document by newEquipment.

Clones newEquipment, so following changes to newEquipment are NOT reflected in the document.

Parameters:

newEquipment - new Equipment.

See Also:

SRDocumentFactory.newEquipment(java.lang.String, java.lang.String, java.lang.String)

getSOPClassUID

java.lang.String getSOPClassUID()

Returns SOP Class UID of this document. SOP Class UID is a readonly attribute of document.

Returns:

SOP Class UID of this document.

getSOPInstanceUID

java.lang.String getSOPInstanceUID()

Returns SOP Instance UID of this document.

Returns:

SOP Class UID of this document.

setSOPInstanceUID

void setSOPInstanceUID(java.lang.String newSOPInstanceUID)

Sets new SOP Instance UID of this document.

Parameters:

newSOPInstanceUID - new SOP Instance UID.

getSpecificCharacterSet

java.lang.String getSpecificCharacterSet()

Returns Specific Character Set for data values of this document.

Returns:

Specific Character Set code string.

setSpecificCharacterSet

void setSpecificCharacterSet(java.lang.String charset)

Sets Specific Character Set for data values of this document.

Parameters:

charset - Specific Character Set code string.

getInstanceCreationDateTime

java.util.Date getInstanceCreationDateTime()

Returns Instance Creation DateTime of this document.

Returns:

Instance Creation DateTime.

setInstanceCreationDateTime

void setInstanceCreationDateTime(java.util.Date dateTime)

Sets Instance Creation DateTime of this document.

Parameters:

dateTime - new Instance Creation DateTime.

getInstanceCreatorUID

java.lang.String getInstanceCreatorUID()

Returns Instance Creator UID of this document.

Returns:

Instance Creation DateTime.

setInstanceCreatorUID

void setInstanceCreatorUID(java.lang.String uid)

Sets Instance Creator UID of this document.

Parameters:

uid - new Instance Creator UID.

getInstanceNumber

int getInstanceNumber()

Returns Instance Number of this document.

Returns:

Instance Number.

setInstanceNumber

void setInstanceNumber(int no)

Sets Instance Number of this document.

Parameters:

no - new Instance Number.

getContentDateTime

java.util.Date getContentDateTime()

Returns Content DateTime of this document.

Returns:

Content DateTime.

setContentDateTime

void setContentDateTime(java.util.Date dateTime)

Sets Content DateTime of this document.

Parameters:

dateTime - new Content DateTime.

getRequests

Request[] getRequests()

Returns array of Request objects, identifing Requested Procedures which are being fulfilled by creation of this document.

Returns:

Requested Procedures references.

Throws:

java.lang.NullPointerException - if ref is null.

setRequests

void setRequests(Request[] requests)

Sets array of Request objects, identifing Requested Procedures which are being fulfilled by creation of this document.

Parameters:

requests - new array of Request objects.

addRequest

boolean addRequest(Request request)

Adds a new Request object, identifing a Requested Procedure which is being fulfilled by creation of this document. Ignores the new Request object, if the document already refers an equal Requested Procedure.

Parameters:

request - identify one Requested Procedure.

Returns:

true if request was added, false if the document already contained the reference.

See Also:

SRDocumentFactory.newRequest(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.dcm4che.srom.Code)

removeRequest

boolean removeRequest(Request request)

Removes the specified Request object, from the list of Requested Procedures of this document.

Returns:

true if the Requested Procedures list of this document contained request; false otherwise.

Throws:

java.lang.NullPointerException - if request is null.

See Also:

SRDocumentFactory.newRequest(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.dcm4che.srom.Code)

getCurrentEvidence

SOPInstanceRef[] getCurrentEvidence()

Returns array of SOPInstanceRef objects, refering all Current Requested Procedure Evidences of this document.

Returns:

references to Current Requested Procedure Evidences.

Throws:

java.lang.NullPointerException - if code is null.

findCurrentEvidence

SOPInstanceRef findCurrentEvidence(RefSOP refSOP)

Returns SOPInstanceRef objects, refering the specified Current Requested Procedure Evidence.

Returns:

reference to Current Requested Procedure Evidences, null if no reference to refSOP was found.

Throws:

java.lang.NullPointerException - if ref is null.

setCurrentEvidence

void setCurrentEvidence(SOPInstanceRef[] refs)

Sets array of SOPInstanceRef objects, refering all Current Requested Procedure Evidences of this document.

Parameters:

refs - new Current Requested Procedure Evidence references.

See Also:

SRDocumentFactory.newSOPInstanceRef(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

addCurrentEvidence

boolean addCurrentEvidence(SOPInstanceRef ref)

Adds a new SOPInstanceRef object, refering a Current Requested Procedure Evidence of this document. Ignores the new SOPInstanceRef object, if the document already refers an equal Current Requested Procedure Evidence.

Parameters:

ref - reference to Current Requested Procedure Evidence.

Returns:

true if ref was added, false if the document already contained the reference.

See Also:

SRDocumentFactory.newSOPInstanceRef(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

removeCurrentEvidence

boolean removeCurrentEvidence(RefSOP ref)

Removes the specified SOPInstanceRef object, from the list of Current Requested Procedure Evidences of this document.

Returns:

true if the document contained the reference, false otherwise.

Throws:

java.lang.NullPointerException - if ref is null.

getIdenticalDocuments

SOPInstanceRef[] getIdenticalDocuments()

Returns array of SOPInstanceRef objects, refering all Identical Documents of this document.

Returns:

references to Identical Documents.

Throws:

java.lang.NullPointerException - if ref is null.

setIdenticalDocuments

void setIdenticalDocuments(SOPInstanceRef[] refs)

Sets array of SOPInstanceRef objects, refering all Identical Documents of this document.

Parameters:

refs - new Identical Documents references.

addIdenticalDocument

boolean addIdenticalDocument(SOPInstanceRef ref)

Adds a new SOPInstanceRef object, refering a Identical Document of this document. Ignores the new SOPInstanceRef object, if the document already refers an equal Identical Document.

Parameters:

ref - reference to Identical Document.

Returns:

true if ref was added, false if the document already contained the reference.

See Also:

SRDocumentFactory.newSOPInstanceRef(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

removeIdenticalDocument

boolean removeIdenticalDocument(RefSOP ref)

Removes the specified SOPInstanceRef object, from the list of Predecessor Document of this document.

Returns:

true if the document contained the reference, false otherwise.

Throws:

java.lang.NullPointerException - if ref is null.

See Also:

SRDocumentFactory.newSOPInstanceRef(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getContent

Content getContent(int[] id)

Returns Content with specified Content Item Identifier. Returns null, if this document does not contain a Content Item with the specified Content Item Identifier.

Parameters:

id - Content Item Identifier.

Returns:

Content with specified Content Item Identifier, null if there is no such Content.

Throws:

java.lang.NullPointerException - if id is null.

java.lang.IllegalArgumentException - if id is not a valid Content Item Identifier.

createContainerContent

ContainerContent createContainerContent(java.util.Date obsDateTime,
                                        Template template,
                                        Code name,
                                        boolean separate)

Creates new ContainerContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Section Heading or null.

separate - specifies Continuity of Content.

Returns:

created ContainerContent object.

createTextContent

TextContent createTextContent(java.util.Date obsDateTime,
                              Template template,
                              Code name,
                              java.lang.String text)

Creates new TextContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

text - Text Value string.

Returns:

created TextContent object.

Throws:

java.lang.NullPointerException - if name or text are null.

java.lang.IllegalArgumentException - if text is an empty string.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createPNameContent

PNameContent createPNameContent(java.util.Date obsDateTime,
                                Template template,
                                Code name,
                                java.lang.String pname)

Creates new PNameContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

pname - Person Name string.

Returns:

created PNameContent object.

Throws:

java.lang.NullPointerException - if name or pname are null.

java.lang.IllegalArgumentException - if pname is an empty string.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createUIDRefContent

UIDRefContent createUIDRefContent(java.util.Date obsDateTime,
                                  Template template,
                                  Code name,
                                  java.lang.String uid)

Creates new UIDRefContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

uid - UID string.

Returns:

created UIDRefContent object.

Throws:

java.lang.NullPointerException - if name or uid are null.

java.lang.IllegalArgumentException - if uid is an empty string.

createCodeContent

CodeContent createCodeContent(java.util.Date obsDateTime,
                              Template template,
                              Code name,
                              Code code)

Creates new CodeContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

code - Concept Code.

Returns:

created CodeContent object.

Throws:

java.lang.NullPointerException - if name or code are null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createNumContent

NumContent createNumContent(java.util.Date obsDateTime,
                            Template template,
                            Code name,
                            float value,
                            Code unit)

Creates new NumContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

value - Numeric Value float.

unit - Measurement Unit Code.

Returns:

created NumContent object.

Throws:

java.lang.NullPointerException - if name or unit are null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createNumContent

NumContent createNumContent(java.util.Date obsDateTime,
                            Template template,
                            Code name,
                            java.lang.Float value,
                            Code unit,
                            Code qualifier)

Creates new NumContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

value - Numeric Value Float.

unit - Measurement Unit Code.

qualifier - Numeric Value Qualifier Code.

Returns:

created NumContent object.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createDateContent

DateContent createDateContent(java.util.Date obsDateTime,
                              Template template,
                              Code name,
                              java.util.Date date)

Creates new DateContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

date - Date value.

Returns:

created DateContent object.

Throws:

java.lang.NullPointerException - if name or date are null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createTimeContent

TimeContent createTimeContent(java.util.Date obsDateTime,
                              Template template,
                              Code name,
                              java.util.Date time)

Creates new TimeContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

time - Time value.

Returns:

created TimeContent object.

Throws:

java.lang.NullPointerException - if name or time are null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createDateTimeContent

DateTimeContent createDateTimeContent(java.util.Date obsDateTime,
                                      Template template,
                                      Code name,
                                      java.util.Date dateTime)

Creates new TimeContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code.

dateTime - DateTime value.

Returns:

created TimeContent object.

Throws:

java.lang.NullPointerException - if name or dateTime are null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createCompositeContent

CompositeContent createCompositeContent(java.util.Date obsDateTime,
                                        Template template,
                                        Code name,
                                        RefSOP refSOP)

Creates new CompositeContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

refSOP - Composite Object Reference.

Returns:

created CompositeContent object.

Throws:

java.lang.NullPointerException - if refSOP is null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newRefSOP(java.lang.String, java.lang.String)

createImageContent

ImageContent createImageContent(java.util.Date obsDateTime,
                                Template template,
                                Code name,
                                RefSOP refSOP,
                                int[] frameNumbers,
                                RefSOP refPresentationSOP,
                                IconImage iconImage)

Creates new ImageContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

refSOP - Composite Object Reference.

frameNumbers - Referenced Frame Number(s) or null.

refPresentationSOP - Softcopy Presentation State Reference or null.

iconImage - Icon Image or null.

Returns:

created ImageContent object.

Throws:

java.lang.NullPointerException - if refSOP is null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newRefSOP(java.lang.String, java.lang.String), SRDocumentFactory.newIconImage(int, int, byte[])

createWaveformContent

WaveformContent createWaveformContent(java.util.Date obsDateTime,
                                      Template template,
                                      Code name,
                                      RefSOP refSOP,
                                      int[] channelNumbers)

Creates new WaveformContent with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

refSOP - Composite Object Reference.

channelNumbers - Referenced Channel Number(s) or null.

Returns:

created WaveformContent object.

Throws:

java.lang.NullPointerException - if refSOP is null.

java.lang.IllegalArgumentException - if channelNumbers contains an odd number of ints.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newRefSOP(java.lang.String, java.lang.String)

createPointSCoordContent

SCoordContent.Point createPointSCoordContent(java.util.Date obsDateTime,
                                             Template template,
                                             Code name,
                                             float[] graphicData)

Creates new SCoordContent.Point with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

graphicData - float[2] with (column,row) value.

Returns:

created SCoordContent.Point object.

Throws:

java.lang.NullPointerException - if graphicData is null.

java.lang.IllegalArgumentException - if graphicData contains more or less than 2 floats.

createMultiPointSCoordContent

SCoordContent.MultiPoint createMultiPointSCoordContent(java.util.Date obsDateTime,
                                                       Template template,
                                                       Code name,
                                                       float[] graphicData)

Creates new SCoordContent.MultiPoint with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

graphicData - float[2N] with N (column,row) values.

Returns:

created SCoordContent.MultiPoint object.

Throws:

java.lang.NullPointerException - if graphicData is null.

java.lang.IllegalArgumentException - if graphicData contains an odd number of floats.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createPolylineSCoordContent

SCoordContent.Polyline createPolylineSCoordContent(java.util.Date obsDateTime,
                                                   Template template,
                                                   Code name,
                                                   float[] graphicData)

Creates new SCoordContent.Polyline with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

graphicData - float[2N] with N (column,row) values.

Returns:

created SCoordContent.Polyline object.

Throws:

java.lang.NullPointerException - if graphicData is null.

java.lang.IllegalArgumentException - if graphicData contains an odd number of floats.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createCircleSCoordContent

SCoordContent.Circle createCircleSCoordContent(java.util.Date obsDateTime,
                                               Template template,
                                               Code name,
                                               float[] graphicData)

Creates new SCoordContent.Circle with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

graphicData - float[4] with (column,row) of central pixel, followed by (column,row) of pixel on the perimeter of the circle.

Returns:

created SCoordContent.Circle object.

Throws:

java.lang.NullPointerException - if graphicData is null.

java.lang.IllegalArgumentException - if graphicData contains more or less than 4 floats.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createEllipseSCoordContent

SCoordContent.Ellipse createEllipseSCoordContent(java.util.Date obsDateTime,
                                                 Template template,
                                                 Code name,
                                                 float[] graphicData)

Creates new SCoordContent.Ellipse with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

graphicData - float[8] with 4 (column,row) values, specifying the endpoints of the major axis followed by the endpoints of the minor axis of the ellipse.

Returns:

created SCoordContent.Ellipse object.

Throws:

java.lang.NullPointerException - if graphicData is null.

java.lang.IllegalArgumentException - if graphicData contains more or less than 8 floats.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date)

createPointTCoordContent

TCoordContent.Point createPointTCoordContent(java.util.Date obsDateTime,
                                             Template template,
                                             Code name,
                                             TCoordContent.Positions positions)

Creates new TCoordContent.Point with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with one entry.

Returns:

created TCoordContent.Point object.

Throws:

java.lang.NullPointerException - if positions is null.

java.lang.IllegalArgumentException - if positions contains more or less than 1 entry.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createMultiPointTCoordContent

TCoordContent.MultiPoint createMultiPointTCoordContent(java.util.Date obsDateTime,
                                                       Template template,
                                                       Code name,
                                                       TCoordContent.Positions positions)

Creates new TCoordContent.MultiPoint with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with one entry.

Returns:

created TCoordContent.MultiPoint object.

Throws:

java.lang.NullPointerException - if positions is null.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createSegmentTCoordContent

TCoordContent.Segment createSegmentTCoordContent(java.util.Date obsDateTime,
                                                 Template template,
                                                 Code name,
                                                 TCoordContent.Positions positions)

Creates new TCoordContent.Segment with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with two entries.

Returns:

created TCoordContent.Segment object.

Throws:

java.lang.NullPointerException - if positions is null.

java.lang.IllegalArgumentException - if positions contains more or less than two entries.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createMultiSegmentTCoordContent

TCoordContent.MultiSegment createMultiSegmentTCoordContent(java.util.Date obsDateTime,
                                                           Template template,
                                                           Code name,
                                                           TCoordContent.Positions positions)

Creates new TCoordContent.MultiSegment with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with 2N entries.

Returns:

created TCoordContent.MultiSegment object.

Throws:

java.lang.NullPointerException - if positions is null.

java.lang.IllegalArgumentException - if positions contains an odd number of entries.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createBeginTCoordContent

TCoordContent.Begin createBeginTCoordContent(java.util.Date obsDateTime,
                                             Template template,
                                             Code name,
                                             TCoordContent.Positions positions)

Creates new TCoordContent.Begin with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with one entry.

Returns:

created TCoordContent.Begin object.

Throws:

java.lang.NullPointerException - if positions is null.

java.lang.IllegalArgumentException - if positions contains more or less than one entry.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createEndTCoordContent

TCoordContent.End createEndTCoordContent(java.util.Date obsDateTime,
                                         Template template,
                                         Code name,
                                         TCoordContent.Positions positions)

Creates new TCoordContent.End with specified properties.

Parameters:

obsDateTime - Observation DateTime or null.

template - Content Template or null.

name - Concept Name Code or null.

positions - TCoordContent.Positions with one entry.

Returns:

created TCoordContent.End object.

Throws:

java.lang.NullPointerException - if positions is null.

java.lang.IllegalArgumentException - if positions contains more or less than one entry.

See Also:

SRDocumentFactory.newCode(java.lang.String, java.lang.String, java.lang.String, java.lang.String), SRDocumentFactory.newTemplate(java.lang.String, java.lang.String, java.util.Date, java.util.Date), SRDocumentFactory.newSamplePositions(int[]), SRDocumentFactory.newRelativePositions(float[]), SRDocumentFactory.newAbsolutePositions(java.util.Date[])

createReferencedContent

ReferencedContent createReferencedContent(Content refContent)

Creates new ReferencedContent which refers the specified Content.

Parameters:

refContent - referenced Content.

Returns:

created ReferencedContent object.

Throws:

java.lang.NullPointerException - if refContent is null.

java.lang.IllegalArgumentException - if refContent is not in the content tree of this document, or if refContent is a ReferencedContent.

createReferencedContent

ReferencedContent createReferencedContent(int[] refContentId)

Creates new ReferencedContent which refers the specified Content. The referenced Content may not yet be inserted into the content tree of this document at creation time. But ReferencedContent.getRefContent() will fail, throwing a NoSuchElementException, as long the document does not contain a Content with the specified Content Item Identifier.

Parameters:

refContentId - Content Item Identifier of referenced Content.

Returns:

created ReferencedContent object.

Throws:

java.lang.NullPointerException - if refContentId is null.

java.lang.IllegalArgumentException - if refContentId is not a valid Content Item Identifier.

importContent

Content importContent(Content importedContent,
                      boolean deep)

Imports content from another document to this document. The returned content has no parent.

The Observation DateTime of the imported content is explicitly set to importedContent.getObservationDateTime(true).

Parameters:

importedContent - The content to import.

deep - If true, recursively imports the subtree under the specified content; if false, imports only the content itself.

Returns:

The imported content.

Throws:

java.lang.NullPointerException - if importedContent is null.

See Also:

Content.clone(boolean)

toDataset

Dataset toDataset()