org.dcm4che2.audit.message
Class ParticipantObject

java.lang.Object
  org.dcm4che2.audit.message.ParticipantObject

public class ParticipantObject
extends java.lang.Object

Identifies instances of data or objects that have been accessed.

Since:

Nov 17, 2006

Version:

$Revision: 6823 $ $Date: 2008-08-21 14:58:03 +0200 (Thu, 21 Aug 2008) $

Author:

Gunter Zeilinger

Nested Class Summary

static class	ParticipantObject.DataLifeCycle
static class	ParticipantObject.Detail
static class	ParticipantObject.IDTypeCode
static class	ParticipantObject.TypeCode
static class	ParticipantObject.TypeCodeRole

Constructor Summary

ParticipantObject(java.lang.String id, ParticipantObject.IDTypeCode idTypeCode)
Create a participant object identified by the given id, of type specified by idTypeCode.

Method Summary

protected void	addAttribute(java.lang.String name, byte[] val, boolean optional)
protected void	addAttribute(java.lang.String name, java.util.Date val, boolean optional)
protected void	addAttribute(java.lang.String name, java.lang.Object val, boolean optional)
ParticipantObject	addParticipantObjectDescription(ParticipantObjectDescription desc)
ParticipantObject	addParticipantObjectDetail(java.lang.String type, byte[] value)
ParticipantObject	addParticipantObjectDetail(java.lang.String type, java.lang.String value)
static ParticipantObject	createAlertSubject(java.lang.String id, ParticipantObject.IDTypeCode idTypeCode, java.lang.String desc)
static ParticipantObject	createAlertSubjectWithNodeID(java.lang.String nodeID, java.lang.String desc)
static ParticipantObject	createAlertSubjectWithURI(java.lang.String uri, java.lang.String desc)
static ParticipantObject	createDataRepository(java.lang.String uri)
static ParticipantObject	createPatient(java.lang.String id, java.lang.String name)
static ParticipantObject	createQuerySOPClass(java.lang.String cuid, java.lang.String tsuid, byte[] query)
static ParticipantObject	createSecurityAuditLog(java.lang.String uri)
static ParticipantObject	createStudy(java.lang.String uid, ParticipantObjectDescription desc) Create a participant object with type code STUDY_INSTANCE_UID, and the specified description (which maybe null).
protected java.lang.Object	getAttribute(java.lang.String name)
ParticipantObject.DataLifeCycle	getParticipantObjectDataLifeCycle()
java.util.List<ParticipantObjectDescription>	getParticipantObjectDescriptions()
java.util.List<ParticipantObject.Detail>	getParticipantObjectDetails()
java.lang.String	getParticipantObjectID() Returns the id specified for this object when it was created
ParticipantObject.IDTypeCode	getParticipantObjectIDTypeCode()
java.lang.String	getParticipantObjectName()
byte[]	getParticipantObjectQuery()
java.lang.String	getParticipantObjectSensitivity()
ParticipantObject.TypeCode	getParticipantObjectTypeCode()
ParticipantObject.TypeCodeRole	getParticipantObjectTypeCodeRole()
protected boolean	isEmpty()
void	output(java.io.Writer out)
protected void	outputChilds(java.io.Writer out, java.util.List<? extends org.dcm4che2.audit.message.BaseElement> childs)
protected void	outputContent(java.io.Writer out) Allows subclasses to write content to the output.
ParticipantObject	setParticipantObjectDataLifeCycle(ParticipantObject.DataLifeCycle code)
ParticipantObject	setParticipantObjectName(java.lang.String name)
ParticipantObject	setParticipantObjectQuery(byte[] query)
ParticipantObject	setParticipantObjectSensitivity(java.lang.String sensitivity)
ParticipantObject	setParticipantObjectTypeCode(ParticipantObject.TypeCode code)
ParticipantObject	setParticipantObjectTypeCodeRole(ParticipantObject.TypeCodeRole code)
java.lang.String	toString()
java.lang.String	toString(int initialSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticipantObject

public ParticipantObject(java.lang.String id,
                         ParticipantObject.IDTypeCode idTypeCode)

Create a participant object identified by the given id, of type specified by idTypeCode. Additionally, participant details can be added afterwards to specify the participant more completely.

Method Detail

getParticipantObjectID

public final java.lang.String getParticipantObjectID()

Returns the id specified for this object when it was created

getParticipantObjectIDTypeCode

public final ParticipantObject.IDTypeCode getParticipantObjectIDTypeCode()

getParticipantObjectTypeCode

public final ParticipantObject.TypeCode getParticipantObjectTypeCode()

setParticipantObjectTypeCode

public final ParticipantObject setParticipantObjectTypeCode(ParticipantObject.TypeCode code)

getParticipantObjectTypeCodeRole

public final ParticipantObject.TypeCodeRole getParticipantObjectTypeCodeRole()

setParticipantObjectTypeCodeRole

public final ParticipantObject setParticipantObjectTypeCodeRole(ParticipantObject.TypeCodeRole code)

getParticipantObjectDataLifeCycle

public final ParticipantObject.DataLifeCycle getParticipantObjectDataLifeCycle()

setParticipantObjectDataLifeCycle

public final ParticipantObject setParticipantObjectDataLifeCycle(ParticipantObject.DataLifeCycle code)

getParticipantObjectSensitivity

public final java.lang.String getParticipantObjectSensitivity()

setParticipantObjectSensitivity

public final ParticipantObject setParticipantObjectSensitivity(java.lang.String sensitivity)

getParticipantObjectName

public final java.lang.String getParticipantObjectName()

setParticipantObjectName

public final ParticipantObject setParticipantObjectName(java.lang.String name)

getParticipantObjectQuery

public final byte[] getParticipantObjectQuery()

setParticipantObjectQuery

public final ParticipantObject setParticipantObjectQuery(byte[] query)

getParticipantObjectDetails

public java.util.List<ParticipantObject.Detail> getParticipantObjectDetails()

addParticipantObjectDetail

public ParticipantObject addParticipantObjectDetail(java.lang.String type,
                                                    java.lang.String value)

addParticipantObjectDetail

public ParticipantObject addParticipantObjectDetail(java.lang.String type,
                                                    byte[] value)

getParticipantObjectDescriptions

public java.util.List<ParticipantObjectDescription> getParticipantObjectDescriptions()

addParticipantObjectDescription

public ParticipantObject addParticipantObjectDescription(ParticipantObjectDescription desc)

isEmpty

protected boolean isEmpty()

outputContent

protected void outputContent(java.io.Writer out)
                      throws java.io.IOException

Allows subclasses to write content to the output. Note to implementers: isEmpty() should also be overridden to return false, otherwise this method will not be called.

Parameters:

out - the writer to write the output to.

Throws:

java.io.IOException - thrown by derived classes if an error occurs.

createPatient

public static ParticipantObject createPatient(java.lang.String id,
                                              java.lang.String name)

createStudy

public static ParticipantObject createStudy(java.lang.String uid,
                                            ParticipantObjectDescription desc)

Create a participant object with type code STUDY_INSTANCE_UID, and the specified description (which maybe null).

Parameters:

uid - Study Instance UID

desc - (null) Description including patient name/id

createDataRepository

public static ParticipantObject createDataRepository(java.lang.String uri)

createQuerySOPClass

public static ParticipantObject createQuerySOPClass(java.lang.String cuid,
                                                    java.lang.String tsuid,
                                                    byte[] query)

createSecurityAuditLog

public static ParticipantObject createSecurityAuditLog(java.lang.String uri)

createAlertSubject

public static ParticipantObject createAlertSubject(java.lang.String id,
                                                   ParticipantObject.IDTypeCode idTypeCode,
                                                   java.lang.String desc)

createAlertSubjectWithURI

public static ParticipantObject createAlertSubjectWithURI(java.lang.String uri,
                                                          java.lang.String desc)

createAlertSubjectWithNodeID

public static ParticipantObject createAlertSubjectWithNodeID(java.lang.String nodeID,
                                                             java.lang.String desc)

addAttribute

protected void addAttribute(java.lang.String name,
                            java.lang.Object val,
                            boolean optional)

addAttribute

protected void addAttribute(java.lang.String name,
                            java.util.Date val,
                            boolean optional)

addAttribute

protected void addAttribute(java.lang.String name,
                            byte[] val,
                            boolean optional)

getAttribute

protected java.lang.Object getAttribute(java.lang.String name)

output

public void output(java.io.Writer out)
            throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(int initialSize)

outputChilds

protected void outputChilds(java.io.Writer out,
                            java.util.List<? extends org.dcm4che2.audit.message.BaseElement> childs)
                     throws java.io.IOException

Throws:

java.io.IOException