org.dcm4che2.hp
Class HangingProtocol

java.lang.Object
  org.dcm4che2.hp.HangingProtocol

public class HangingProtocol
extends java.lang.Object

Since:

Jul 30, 2005

Version:

$Revision: 6915 $ $Date: 2008-08-31 23:36:20 +0200 (Sun, 31 Aug 2008) $

Author:

gunter zeilinger(gunterze@gmail.com)

Constructor Summary

HangingProtocol()

HangingProtocol(DicomObject dcmobj)

HangingProtocol(HangingProtocol source)

Method Summary

void	addDisplaySet(HPDisplaySet displaySet) Deprecated. use addNewDisplaySet instead
void	addHangingProtocolDefinition(HPDefinition def)
void	addNavigationGroup(HPNavigationGroup navigationGroup)
HPDisplaySet	addNewDisplaySet(HPImageSet imageSet, HPDisplaySet prototype)
HPImageSet	addNewImageSet(HPImageSet shareSelectors)
void	addNominalScreenDefinition(HPScreenDefinition def)
void	addScrollingGroup(HPScrollingGroup scrollingGroup)
protected HPDisplaySet	createDisplaySet(DicomObject ds, HPImageSet is)
protected HPDefinition	createHangingProtocolDefinition(DicomObject dcmobj)
protected HPImageSet	createImageSet(java.util.List<HPSelector> selectors, DicomObject dcmobj)
protected HPNavigationGroup	createNavigationGroup(DicomObject dcmobj)
protected HPScreenDefinition	createNominalScreenDefinition(DicomObject item)
protected HPScrollingGroup	createScrollingGroup(DicomObject dssg)
protected void	doAddDisplaySet(HPDisplaySet displaySet)
DicomObject	getDicomObject() Returns the DicomObject that backs this HangingProtocol.
java.lang.String	getDisplaySetPresentationGroupDescription(int pgNo)
java.util.List<HPDisplaySet>	getDisplaySets()
java.util.List<HPDisplaySet>	getDisplaySetsOfImageSet(HPImageSet is)
java.util.List<HPDisplaySet>	getDisplaySetsOfPresentationGroup(int pgNo)
java.util.Date	getHangingProtocolCreationDateTime()
java.lang.String	getHangingProtocolCreator()
java.util.List<HPDefinition>	getHangingProtocolDefinitions()
java.lang.String	getHangingProtocolDescription()
java.lang.String	getHangingProtocolLevel()
java.lang.String	getHangingProtocolName()
java.lang.String	getHangingProtocolUserGroupName()
Code	getHangingProtocolUserIdentificationCode()
static HPComparatorSpi	getHPComparatorSpi(java.lang.String category)
static HPSelectorSpi	getHPSelectorSpi(java.lang.String category)
java.util.List<HPImageSet>	getImageSets()
java.util.Date	getInstanceCreationDateTime()
java.lang.String	getInstanceCreatorUID()
java.lang.String	getInstanceNumber()
java.util.List<HPNavigationGroup>	getNavigationGroups()
java.util.List<HPScreenDefinition>	getNominalScreenDefinitions()
int	getNumberOfPresentationGroups()
int	getNumberOfPriorsReferenced()
int	getNumberOfScreens()
java.lang.String	getOriginalSpecializedSOPClassUID()
java.lang.String	getPartialDataDisplayHandling()
java.lang.String	getRelatedGeneralSOPClassUID()
java.util.List<HPScrollingGroup>	getScrollingGroups()
java.lang.String	getSOPClassUID()
java.lang.String	getSOPInstanceUID()
ReferencedSOP	getSourceHangingProtocol()
java.lang.String[]	getSpecificCharacterSet()
static java.lang.String[]	getSupportedHPComparatorCategories()
static java.lang.String[]	getSupportedHPSelectorCategories()
void	removeAllDisplaySets()
void	removeAllHangingProtocolDefinition()
void	removeAllImageSets()
void	removeAllNavigationGroups()
void	removeAllNominalScreenDefinitions()
void	removeAllScrollingGroups()
boolean	removeDisplaySet(HPDisplaySet displaySet)
boolean	removeHangingProtocolDefinition(HPDefinition def)
boolean	removeImageSet(HPImageSet imageSet)
boolean	removeNavigationGroup(HPNavigationGroup navigationGroup)
boolean	removeNominalScreenDefinition(HPScreenDefinition def)
boolean	removeScrollingGroup(HPScrollingGroup scrollingGroup)
static void	scanForPlugins(java.lang.ClassLoader cl)
void	setHangingProtocolCreationDateTime(java.util.Date datetime)
void	setHangingProtocolCreator(java.lang.String creator)
void	setHangingProtocolDescription(java.lang.String description)
void	setHangingProtocolLevel(java.lang.String level)
void	setHangingProtocolName(java.lang.String name)
void	setHangingProtocolUserGroupName(java.lang.String name)
void	setHangingProtocolUserIdentificationCodeSequence(Code user)
void	setInstanceCreationDateTime(java.util.Date d)
void	setInstanceCreatorUID(java.lang.String s)
void	setInstanceNumber(java.lang.String s)
void	setNumberOfPriorsReferenced(int priors)
void	setNumberOfScreens(int screens)
void	setOriginalSpecializedSOPClassUID(java.lang.String s)
void	setPartialDataDisplayHandling(java.lang.String type)
void	setRelatedGeneralSOPClassUID(java.lang.String s)
void	setSOPClassUID(java.lang.String uid)
void	setSOPInstanceUID(java.lang.String uid)
void	setSourceHangingProtocol(ReferencedSOP sop)
void	setSpecificCharacterSet(java.lang.String[] ss)

Methods inherited from class java.lang.Object

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

Constructor Detail

HangingProtocol

public HangingProtocol(DicomObject dcmobj)

HangingProtocol

public HangingProtocol()

HangingProtocol

public HangingProtocol(HangingProtocol source)

Method Detail

createImageSet

protected HPImageSet createImageSet(java.util.List<HPSelector> selectors,
                                    DicomObject dcmobj)

createDisplaySet

protected HPDisplaySet createDisplaySet(DicomObject ds,
                                        HPImageSet is)

createHangingProtocolDefinition

protected HPDefinition createHangingProtocolDefinition(DicomObject dcmobj)

createNominalScreenDefinition

protected HPScreenDefinition createNominalScreenDefinition(DicomObject item)

createNavigationGroup

protected HPNavigationGroup createNavigationGroup(DicomObject dcmobj)

createScrollingGroup

protected HPScrollingGroup createScrollingGroup(DicomObject dssg)

getDicomObject

public DicomObject getDicomObject()

Returns the DicomObject that backs this HangingProtocol. Direct modifications of the returned DicomObject is strongly discouraged as it may cause inconsistencies in the internal state of this object.

Returns:

the DicomObject that backs this Hanging Protocol

getHangingProtocolName

public java.lang.String getHangingProtocolName()

setHangingProtocolName

public void setHangingProtocolName(java.lang.String name)

getHangingProtocolDescription

public java.lang.String getHangingProtocolDescription()

setHangingProtocolDescription

public void setHangingProtocolDescription(java.lang.String description)

getHangingProtocolLevel

public java.lang.String getHangingProtocolLevel()

setHangingProtocolLevel

public void setHangingProtocolLevel(java.lang.String level)

getHangingProtocolCreator

public java.lang.String getHangingProtocolCreator()

setHangingProtocolCreator

public void setHangingProtocolCreator(java.lang.String creator)

getHangingProtocolCreationDateTime

public java.util.Date getHangingProtocolCreationDateTime()

setHangingProtocolCreationDateTime

public void setHangingProtocolCreationDateTime(java.util.Date datetime)

getNumberOfPriorsReferenced

public int getNumberOfPriorsReferenced()

setNumberOfPriorsReferenced

public void setNumberOfPriorsReferenced(int priors)

getNumberOfScreens

public int getNumberOfScreens()

setNumberOfScreens

public void setNumberOfScreens(int screens)

getHangingProtocolUserIdentificationCode

public Code getHangingProtocolUserIdentificationCode()

setHangingProtocolUserIdentificationCodeSequence

public void setHangingProtocolUserIdentificationCodeSequence(Code user)

getSourceHangingProtocol

public ReferencedSOP getSourceHangingProtocol()

setSourceHangingProtocol

public void setSourceHangingProtocol(ReferencedSOP sop)

getHangingProtocolUserGroupName

public java.lang.String getHangingProtocolUserGroupName()

setHangingProtocolUserGroupName

public void setHangingProtocolUserGroupName(java.lang.String name)

getPartialDataDisplayHandling

public java.lang.String getPartialDataDisplayHandling()

setPartialDataDisplayHandling

public void setPartialDataDisplayHandling(java.lang.String type)

getHangingProtocolDefinitions

public java.util.List<HPDefinition> getHangingProtocolDefinitions()

addHangingProtocolDefinition

public void addHangingProtocolDefinition(HPDefinition def)

removeHangingProtocolDefinition

public boolean removeHangingProtocolDefinition(HPDefinition def)

removeAllHangingProtocolDefinition

public void removeAllHangingProtocolDefinition()

getImageSets

public java.util.List<HPImageSet> getImageSets()

addNewImageSet

public HPImageSet addNewImageSet(HPImageSet shareSelectors)

removeImageSet

public boolean removeImageSet(HPImageSet imageSet)

removeAllImageSets

public void removeAllImageSets()

getNominalScreenDefinitions

public java.util.List<HPScreenDefinition> getNominalScreenDefinitions()

addNominalScreenDefinition

public void addNominalScreenDefinition(HPScreenDefinition def)

removeNominalScreenDefinition

public boolean removeNominalScreenDefinition(HPScreenDefinition def)

removeAllNominalScreenDefinitions

public void removeAllNominalScreenDefinitions()

getNumberOfPresentationGroups

public int getNumberOfPresentationGroups()

getDisplaySetsOfPresentationGroup

public java.util.List<HPDisplaySet> getDisplaySetsOfPresentationGroup(int pgNo)

getDisplaySetsOfImageSet

public java.util.List<HPDisplaySet> getDisplaySetsOfImageSet(HPImageSet is)

getDisplaySetPresentationGroupDescription

public java.lang.String getDisplaySetPresentationGroupDescription(int pgNo)

getDisplaySets

public java.util.List<HPDisplaySet> getDisplaySets()

addNewDisplaySet

public HPDisplaySet addNewDisplaySet(HPImageSet imageSet,
                                     HPDisplaySet prototype)

addDisplaySet

@Deprecated
public void addDisplaySet(HPDisplaySet displaySet)

Deprecated. use addNewDisplaySet instead

doAddDisplaySet

protected void doAddDisplaySet(HPDisplaySet displaySet)

removeDisplaySet

public boolean removeDisplaySet(HPDisplaySet displaySet)

removeAllDisplaySets

public void removeAllDisplaySets()

getScrollingGroups

public java.util.List<HPScrollingGroup> getScrollingGroups()

addScrollingGroup

public void addScrollingGroup(HPScrollingGroup scrollingGroup)

removeScrollingGroup

public boolean removeScrollingGroup(HPScrollingGroup scrollingGroup)

removeAllScrollingGroups

public void removeAllScrollingGroups()

getNavigationGroups

public java.util.List<HPNavigationGroup> getNavigationGroups()

addNavigationGroup

public void addNavigationGroup(HPNavigationGroup navigationGroup)

removeNavigationGroup

public boolean removeNavigationGroup(HPNavigationGroup navigationGroup)

removeAllNavigationGroups

public void removeAllNavigationGroups()

scanForPlugins

public static void scanForPlugins(java.lang.ClassLoader cl)

getHPSelectorSpi

public static HPSelectorSpi getHPSelectorSpi(java.lang.String category)

getHPComparatorSpi

public static HPComparatorSpi getHPComparatorSpi(java.lang.String category)

getSupportedHPSelectorCategories

public static java.lang.String[] getSupportedHPSelectorCategories()

getSupportedHPComparatorCategories

public static java.lang.String[] getSupportedHPComparatorCategories()

getSOPClassUID

public java.lang.String getSOPClassUID()

setSOPClassUID

public void setSOPClassUID(java.lang.String uid)

getSOPInstanceUID

public java.lang.String getSOPInstanceUID()

setSOPInstanceUID

public void setSOPInstanceUID(java.lang.String uid)

getSpecificCharacterSet

public java.lang.String[] getSpecificCharacterSet()

setSpecificCharacterSet

public void setSpecificCharacterSet(java.lang.String[] ss)

getInstanceCreationDateTime

public java.util.Date getInstanceCreationDateTime()

setInstanceCreationDateTime

public void setInstanceCreationDateTime(java.util.Date d)

getInstanceCreatorUID

public java.lang.String getInstanceCreatorUID()

setInstanceCreatorUID

public void setInstanceCreatorUID(java.lang.String s)

getRelatedGeneralSOPClassUID

public java.lang.String getRelatedGeneralSOPClassUID()

setRelatedGeneralSOPClassUID

public void setRelatedGeneralSOPClassUID(java.lang.String s)

getOriginalSpecializedSOPClassUID

public java.lang.String getOriginalSpecializedSOPClassUID()

setOriginalSpecializedSOPClassUID

public void setOriginalSpecializedSOPClassUID(java.lang.String s)

getInstanceNumber

public java.lang.String getInstanceNumber()

setInstanceNumber

public void setInstanceNumber(java.lang.String s)