cdac.medinfo.sdk.dcm30_04.dicomstreams

Class DicomStream

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicomstreams.DicomStream

All Implemented Interfaces:

IDicomStream

Direct Known Subclasses:

DicomBufferStream, DicomFileStream

public abstract class DicomStream
extends java.lang.Object
implements IDicomStream

This abstract class is parent of all stream classes used in DICOM. Applications that need to define the subclass of DicomStream must set either the input stream or the output stream before start using the class.

See Also:

DicomBufferStream., @FileStream.

Constructor Summary

Constructors

Constructor and Description
DicomStream() Default Constructor for DicomStream.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() This method returns the number of bytes available on the stream
int	close() This method closes the stream.
boolean	endSend() This method shows the end of sending process.
int	getEndianNess() Returns the endianNess of the stream [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.
int	getReadBytes() Keeps track of how much bytes are read from the stream.
int	getStream() Returns the stream type to which it is set to [InputStream/outputStream]
int	mark(int iReadAheadLimit) Marks the current position in this input stream.
int	readBuffer(byte[] arrbyte) Reads buffer byte per byte from stream.
byte	readByte() Reads a single byte from the stream.
char	readChar() Reads a character from the stream.
byte[]	readChars(int iLength) Reads specified number of characters from the stream.
double	readDouble() Reads a double from the stream.
float	readFloat() Reads a float from the stream.
int	readInt() Reads an integer from the stream.
long	readLong() Reads a long from stream.
short	readShort() Reads a short from the stream.
java.lang.String	readString(int iStringLength) Reads a string from the stream with specified length.
byte[]	readWord() Reads a word from stream Note: This method is specifically designed for OW data type of DICOM.
int	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.
int	setEndianNess(int iEndianNess) Sets the endianess of the steam [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.
int	skip(int iNumBytes) This method skips the specified number of bytes from the current position.
boolean	startReceive() Shows the beginning of receiving process.
boolean	writeBuffer(byte[] arrByte, int iOffset, int iLength) Writes a sequence of bytes to the stream.
int	writeByte(byte byteVal) Writes a byte to the stream.
int	writeChar(char charVal) Writes a character to the stream.
int	writeChars(byte[] arrbyteChar) Writes the characters on the stream.
int	writeDouble(double dVal) Writes a double value to the stream.
int	writeFloat(float fVal) Writes a float value to the stream.
int	writeInt(int iVal) Writes an int value to the stream.
int	writeLong(int iVal) Writes a long to the stream.
int	writeShort(short shVal) Writes a short value on to the stream.
int	writeString(java.lang.String strValue) Writes a string to the stream.
int	writeWord(byte[] arrbyteVal) Writes a word to the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

DicomStream

public DicomStream()

Default Constructor for DicomStream.

Method Detail

getStream

public int getStream()

Returns the stream type to which it is set to [InputStream/outputStream]

Specified by:

getStream in interface IDicomStream

Returns:

int - integer value of Stream Type.

getEndianNess

public int getEndianNess()

Returns the endianNess of the stream [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.

Specified by:

getEndianNess in interface IDicomStream

Returns:

int - Integer value shows the endianNess.

setEndianNess

public int setEndianNess(int iEndianNess)

Sets the endianess of the steam [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.

Specified by:

setEndianNess in interface IDicomStream

Parameters:

iEndianNess - the endianess of the steam [BIG_ENDIAN/LITTLE_ENDIAN]

Returns:

int - status indicating success or failure of the method

getReadBytes

public int getReadBytes()

Keeps track of how much bytes are read from the stream. This method is useful when the DicomStream is being used as input stream. When called on DicomStream used as output stream, it returns 0 .

Specified by:

getReadBytes in interface IDicomStream

Returns:

int - number of bytes read when called on DicomStream when used as input stream 0 if the DicomStream is used as output stream.

readByte

public byte readByte()
              throws java.io.IOException

Reads a single byte from the stream. While reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException .

Specified by:

readByte in interface IDicomStream

Returns:

byte - Next read byte value.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readChar

public char readChar()
              throws java.io.IOException

Reads a character from the stream. While reading the specified number of characters from the stream, it doesnt use the endianness set into the stream before reading as DICOM specifies that the characters must be read from left to right regardless of the endianness. When called on DicomStream used as output stream, it throws IOException.

Returns:

char - Next read character value.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readChars

public byte[] readChars(int iLength)
                 throws java.io.IOException

Reads specified number of characters from the stream. While reading the specified number of characters from the stream, it doesn't use the endianness set into the stream before reading as DICOM specifies that the characters must be read from left to right regardless of the endianness. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readChars in interface IDicomStream

Parameters:

iLength - number of characters to read.

Returns:

byte[] - Byte array of next read characters.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

writeChars

public int writeChars(byte[] arrbyteChar)
               throws java.io.IOException

Writes the characters on the stream. While writing the specified number of characters to the stream, it doesn't use the endianness set into the stream before writing as DICOM specifies that the characters must be read from left to right regardless of the endianness When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeChars in interface IDicomStream

Parameters:

arrbyteChar - byte array of characters to write.

Returns:

int - number of bytes written when called on DicomStream when used as output stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

readShort

public short readShort()
                throws java.io.IOException

Reads a short from the stream. while reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readShort in interface IDicomStream

Returns:

short - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readInt

public int readInt()
            throws java.io.IOException

Reads an integer from the stream. while reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readInt in interface IDicomStream

Returns:

int - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readLong

public long readLong()
              throws java.io.IOException

Reads a long from stream. In Java, long is of 8 bytes, but in Dicom Standard long data type length is expected as 4 bytes. So here it reads only 4 bytes from stream. while reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readLong in interface IDicomStream

Returns:

long - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readFloat

public float readFloat()
                throws java.io.IOException

Reads a float from the stream. while reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readFloat in interface IDicomStream

Returns:

float - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readDouble

public double readDouble()
                  throws java.io.IOException

Reads a double from the stream. while reading the byte from the stream, it uses the endianness set into the stream before reading. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readDouble in interface IDicomStream

Returns:

double - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readString

public java.lang.String readString(int iStringLength)
                            throws java.io.IOException

Reads a string from the stream with specified length. While reading the string of length specified, it doesn't use the endianness set into the stream before reading as DICOM specifies that the string of characters must be read from left to right regardless of the endianness. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readString in interface IDicomStream

Parameters:

iStringLength - Length of the string to be read.

Returns:

String - value read from the stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

writeString

public int writeString(java.lang.String strValue)
                throws java.io.IOException

Writes a string to the stream. While writing the specified string to the stream, it doesn't use the endianness set into the stream before writing as DICOM specifies that the characters must be read from left to right regardless of the endianness. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeString in interface IDicomStream

Parameters:

strValue - string to be written.

Returns:

int - success if the string is read successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

readBuffer

public int readBuffer(byte[] arrbyte)
               throws java.io.IOException

Reads buffer byte per byte from stream. This method simply returns the byte array from the stream without applying the rules of endianness. When called on DicomStream used as output stream, it throws IOException.

Specified by:

readBuffer in interface IDicomStream

Parameters:

arrbyte - byte array to be populated by stream.

Returns:

int - number of bytes actually read from input stream

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream..

readWord

public byte[] readWord()
                throws java.io.IOException

Reads a word from stream Note: This method is specifically designed for OW data type of DICOM. OW is other word which represents two bytes word. This word needs to be read according to the endianness set into the stream When called on DicomStream used as output stream, it throws IOException

Specified by:

readWord in interface IDicomStream

Returns:

byte[] - byte array of length 2 which contains the word read from stream.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream.

writeWord

public int writeWord(byte[] arrbyteVal)
              throws java.io.IOException

Writes a word to the stream. Note: This method is specifically designed for OW data type of DICOM. OW is other word which represents two bytes word. This word needs to be written according to the endianness set into the stream.

Specified by:

writeWord in interface IDicomStream

Parameters:

arrbyteVal - byte array of length 2 representing word to be written.

Returns:

int - success if the word is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeByte

public int writeByte(byte byteVal)
              throws java.io.IOException

Writes a byte to the stream. while writing the byte to the stream, it uses the endianness set into the stream before writing When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeByte in interface IDicomStream

Parameters:

byteVal - value to be written.

Returns:

int - success if the byte is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeChar

public int writeChar(char charVal)
              throws java.io.IOException

Writes a character to the stream. while writing the character to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Parameters:

charVal - value to be written.

Returns:

int - success if the character is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeShort

public int writeShort(short shVal)
               throws java.io.IOException

Writes a short value on to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeShort in interface IDicomStream

Parameters:

shVal - value to be written.

Returns:

int - success if the character is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeInt

public int writeInt(int iVal)
             throws java.io.IOException

Writes an int value to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeInt in interface IDicomStream

Parameters:

iVal - integer value to write.

Returns:

int - success if the integer is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeLong

public int writeLong(int iVal)
              throws java.io.IOException

Writes a long to the stream. n Java, long is of 8 bytes, but in Dicom Standard long data type length. is expected as 4 bytes. So here we write 4 bytes only on to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeLong in interface IDicomStream

Parameters:

iVal - Shows long value to write.

Returns:

int - success if the long value is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeFloat

public int writeFloat(float fVal)
               throws java.io.IOException

Writes a float value to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeFloat in interface IDicomStream

Parameters:

fVal - Shows float value to be written.

Returns:

int - success if the float value is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeDouble

public int writeDouble(double dVal)
                throws java.io.IOException

Writes a double value to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeDouble in interface IDicomStream

Parameters:

dVal - double value to be written.

Returns:

int - success if the double value is written successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

writeBuffer

public boolean writeBuffer(byte[] arrByte,
                  int iOffset,
                  int iLength)
                    throws java.io.IOException

Writes a sequence of bytes to the stream. while writing the short to the stream, it uses the endianness set into the stream before writing. When called on DicomStream used as input stream, it throws IOException.

Specified by:

writeBuffer in interface IDicomStream

Parameters:

arrByte - byte array contains value to be written.

iOffset - the start offset in the data.

iLength - the number of bytes to be written.

Returns:

boolean - true/false indicating success/failure of the operation.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as input stream.

startReceive

public boolean startReceive()

Shows the beginning of receiving process.

Specified by:

startReceive in interface IDicomStream

Returns:

boolean - shows status.

endSend

public boolean endSend()
                throws java.io.IOException

This method shows the end of sending process.

Specified by:

endSend in interface IDicomStream

Returns:

boolean - shows status as success or failure.

Throws:

java.io.IOException - Exception if IO operation fails.

mark

public int mark(int iReadAheadLimit)

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The read limit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated. The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than read limit bytes are read from the stream before reset is called. Marking a closed stream should not have any effect on the stream.

Specified by:

mark in interface IDicomStream

Parameters:

iReadAheadLimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

Returns:

int - success if the stream is marked successfully.

reset

public int reset()
          throws java.io.IOException

Repositions this stream to the position at the time the mark method was last called on this input stream. The general contract of reset is: If the method markSupported returns true, then: If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown. If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset. If the method markSupported returns false, then: The call to reset may throw an IOException. If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.

Specified by:

reset in interface IDicomStream

Returns:

int - success if the stream is reseted successfully.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream.

skip

public int skip(int iNumBytes)
         throws java.io.IOException

This method skips the specified number of bytes from the current position.

Specified by:

skip in interface IDicomStream

Parameters:

iNumBytes - number of bytes to be skipped.

Returns:

int - success if the operation is successful.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream.

available

public int available()
              throws java.io.IOException

This method returns the number of bytes available on the stream

Specified by:

available in interface IDicomStream

Returns:

int - Integer value of available bytes.

Throws:

java.io.IOException - If IO operation fails or called on DicomStream used as output stream.

close

public int close()
          throws java.io.IOException

This method closes the stream. If input stream is set into the DicomStream, then it closes the input stream and if output stream is set into the DicomStream, then it closes the output stream,

Specified by:

close in interface IDicomStream

Returns:

int - success if the stream is closed successfully

Throws:

java.io.IOException - Exception if IO operation fails.