org.dicom4j.network.dimse.messages.support
Class AbstractDimseMessage

java.lang.Object
  org.dicom4j.network.dimse.messages.support.AbstractDimseMessage

All Implemented Interfaces:

DimseMessage

Direct Known Subclasses:

CCancelRequest, DimseMessageWithAffectedSOPClass, NormalizedMessage

public abstract class AbstractDimseMessage
extends Object
implements DimseMessage

Base class for DIMSE messages.

A message contains

• a DimseCommandSet
• a DataSet

Since:

0.0.0

Author:

Laurent Lecomte

Constructor Summary

AbstractDimseMessage(CommandSet aDimseCommandSet)

AbstractDimseMessage(int aMessageID)

Method Summary

int	getCommandField() Return the value of the Command Field
CommandSet	getCommandSet() Return the CommandSet
DataSet	getDataSet() Return the DataSet
int	getMessageID() Return the Message ID
String	getName() Return the name of the message
SOPClassRegistry	getSopClassRegistry()
boolean	isCEchoRequest()
boolean	isCEchoResponse()
boolean	isCFindRequest() check if the message if the message is a C-Find-Request
void	removeDataSet() Remove the DataSet from the message.
void	setCommandField(int aCommandField) Set the Command Field
void	setDataSet(DataSet dataSet) set the DataSet.
void	setSopClassRegistry(SOPClassRegistry sopClassRegistry)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDimseMessage

public AbstractDimseMessage(CommandSet aDimseCommandSet)

AbstractDimseMessage

public AbstractDimseMessage(int aMessageID)
                     throws DicomException

Throws:

DicomException

Method Detail

getCommandField

public int getCommandField()

Return the value of the Command Field

Returns:

the CommandField

getCommandSet

public CommandSet getCommandSet()

Return the CommandSet

Specified by:

getCommandSet in interface DimseMessage

Returns:

the CommandSet

getDataSet

public DataSet getDataSet()

Return the DataSet

Specified by:

getDataSet in interface DimseMessage

Returns:

the DataSet

getMessageID

public int getMessageID()

Return the Message ID

Returns:

the Message ID

getName

public String getName()

Return the name of the message

Specified by:

getName in interface DimseMessage

Returns:

the name

isCEchoRequest

public boolean isCEchoRequest()

Returns:

isCEchoResponse

public boolean isCEchoResponse()

Returns:

isCFindRequest

public boolean isCFindRequest()

check if the message if the message is a C-Find-Request

Returns:

true if C-Find

Since:

0.0.5

removeDataSet

public void removeDataSet()
                   throws DicomException

Remove the DataSet from the message.

DataSetType is changed to reflect there no DataSet

Throws:

DicomException

setCommandField

public void setCommandField(int aCommandField)
                     throws DicomException

Set the Command Field

Parameters:

aCommandField - the Command Field

Throws:

DicomException

setDataSet

public void setDataSet(DataSet dataSet)
                throws DicomException

set the DataSet. The DataSetType will be set to "no dataset" is the supplied object is null.

Specified by:

setDataSet in interface DimseMessage

Parameters:

dataSet - the DataSet to set

Throws:

DicomException

getSopClassRegistry

public SOPClassRegistry getSopClassRegistry()

setSopClassRegistry

public void setSopClassRegistry(SOPClassRegistry sopClassRegistry)