com.pixelmed.database.DatabaseInformationModel

com.pixelmed.database.DicomDatabaseInformationModel

Direct Known Subclasses:: MinimalPatientStudySeriesInstanceModel, PatientStudySeriesConcatenationInstanceModel, StudySeriesInstanceModel

public abstract class DicomDatabaseInformationModel extends DatabaseInformationModel

The DicomDatabaseInformationModel class is an abstract class that specializes DatabaseInformationModel by adding methods specific to a typical DICOM composite object information model.

These methods include support for naming the standard DICOM information entities, building insert statements using all the dictionary attributes for a partcular DICOM information entity, and generating local primary keys.

Field Summary

Fields

Modifier and Type

Field

Description

protected static final String

derivedAcquisitionDateTimeColumnName

protected static final String

derivedContentDateTimeColumnName

protected static final String

derivedLossyImageCompressionColumnName

protected static final String

derivedSeriesDateTimeColumnName

protected static final String

derivedStudyDateTimeColumnName

Fields inherited from class com.pixelmed.database.DatabaseInformationModel
additionalIndexMapOfColumnsToTables, databaseConnection, databaseRootName, defaultDatabaseRootName, dictionary, externalServerInstance, FILE_COPIED, FILE_REFERENCED, listsOfAttributesByInformationEntity, localFileName, localFileReferenceTypeColumnName, localParentReferenceColumnName, localPrimaryKeyColumnName, localRecordInsertionTimeColumnName, personNameCanonicalColumnNamePrefix, personNameCanonicalColumnNameSuffix, personNamePhoneticCanonicalColumnNamePrefix, personNamePhoneticCanonicalColumnNameSuffix, rootInformationEntity, userColumnName1, userColumnName2, userColumnName3, userColumnName4
Constructor Summary

Constructors

Constructor

Description

DicomDatabaseInformationModel(String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary)

DicomDatabaseInformationModel(String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary, String databaseRootName)

DicomDatabaseInformationModel(String databaseFileName, String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary)

DicomDatabaseInformationModel(String databaseFileName, String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary, String databaseRootName)
Method Summary

Modifier and Type

Method

Description

protected String

createPrimaryKeyForSelectedInformationEntity(InformationEntity ie)

Create a new unique key which may be used to identify a new instance of an entity.

protected void

extendCreateStatementStringWithDerivedAttributes(StringBuffer b, InformationEntity ie)

Extend a SQL CREATE TABLE statement in the process of being constructed with any derived attributes (columns) that the model requires.

protected void

extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie)

Extend a SQL INSERT statement in the process of being constructed with the names of the attributes in the instance for the entity.

protected void

extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie, String fileName, String fileReferenceType)

Extend a SQL INSERT statement in the process of being constructed with the values of the attributes in the instance for the entity.

protected void

extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie)

Extend a SQL INSERT statement in the process of being constructed with the names of the derived attributes in the instance for the entity.

protected void

extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie)

Extend a SQL INSERT statement in the process of being constructed with the values of the derived attributes in the instance for the entity.

protected void

extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie)

Extend a SQL INSERT statement in the process of being constructed with the names of the additional search columns derived from person name attributes in the instance for the entity.

protected void

extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie)

Extend a SQL INSERT statement in the process of being constructed with the values of the additional search columns derived from person name attributes in the instance for the entity.

Date

getDateFromDicomDateAndTime(String dateTime)

Date

getDateFromDicomDateAndTime(String date, String time, String timezone)

String

getNametoDescribeThisInstanceOfInformationEntity(InformationEntity ie, Map returnedAttributes)

For a particular instance of an information entity, find a descriptive name for the entity suitable for rendering.

QueryResponseGeneratorFactory

getQueryResponseGeneratorFactory()

Get a factory to manufacture a query response generator capable of performing a query and returning the results.

QueryResponseGeneratorFactory

getQueryResponseGeneratorFactory(int debugLevel)

Get a factory to manufacture a query response generator capable of performing a query and returning the results.

static String

getQuotedEscapedSingleStringValueOrNull(Attribute a)

Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.

static String

getQuotedSingleStringValueOrNull(Attribute a, boolean escapeSpecialCharacters)

Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.

static String

getQuotedUnescapedSingleStringValueOrNull(Attribute a)

Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.

static String

getQuotedValueOrNULL(String value)

Make a quoted string value suitable for using in a SQL statement from a (possibly null or empty) string.

RetrieveResponseGeneratorFactory

getRetrieveResponseGeneratorFactory()

Get a factory to manufacture a retrieve response generator capable of performing a retrieve and returning the results.

RetrieveResponseGeneratorFactory

getRetrieveResponseGeneratorFactory(int debugLevel)

Get a factory to manufacture a retrieve response generator capable of performing a retrieve and returning the results.

Timestamp

getTimestampFromDate(Date javaDate)

Timestamp

getTimestampFromDicomDateAndTime(String sdatetime)

Timestamp

getTimestampFromDicomDateAndTime(String date, String time, String timezone)

Methods inherited from class com.pixelmed.database.DatabaseInformationModel
appendExactOrIsNullMatch, close, createAdditionalIndexes, deleteRecord, doCommonConstructorStuff, extendCreateStatementStringWithAnyExtraAttributes, extendCreateStatementStringWithUserColumns, extendStatementStringWithMatchingAttributesForSelectedInformationEntity, finalize, findAllAttributeValuesForAllRecordsForThisInformationEntity, findAllAttributeValuesForAllRecordsForThisInformationEntityWithMatchingParent, findAllAttributeValuesForAllRecordsForThisInformationEntityWithSpecifiedKeyValue, findAllAttributeValuesForAllRecordsForThisInformationEntityWithSpecifiedParent, findAllAttributeValuesForAllRecordsForThisInformationEntityWithSpecifiedUID, findAllAttributeValuesForSelectedRecord, findSelectedAttributeValuesForSelectedRecord, getAttributeTagFromDatabaseColumnName, getChildTypeForParent, getChildTypeForParent, getChildTypeForParent, getDatabaseColumnNameFromDicomName, getDatabaseColumnNameFromDicomTag, getDescriptiveColumnName, getDicomNameFromDatabaseColumnName, getInformationEntityFromTag, getLocalFileNameColumnName, getLocalFileReferenceTypeColumnName, getLocalParentReferenceColumnName, getLocalPrimaryKeyColumnName, getLocalRecordInsertionTimeColumnName, getOtherDescriptiveColumnName, getOtherOtherDescriptiveColumnName, getSQLTypeFromDicomValueRepresentation, getTableNameForInformationEntity, getUIDColumnNameForInformationEntity, insertObject, isInformationEntityInModel, isInformationEntityInModel, toString, updateSelectedRecord

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- derivedStudyDateTimeColumnName
  
  protected static final String derivedStudyDateTimeColumnName
  See Also:
  
  Constant Field Values
- derivedSeriesDateTimeColumnName
  
  protected static final String derivedSeriesDateTimeColumnName
  See Also:
  
  Constant Field Values
- derivedContentDateTimeColumnName
  
  protected static final String derivedContentDateTimeColumnName
  See Also:
  
  Constant Field Values
- derivedAcquisitionDateTimeColumnName
  
  protected static final String derivedAcquisitionDateTimeColumnName
  See Also:
  
  Constant Field Values
- derivedLossyImageCompressionColumnName
  
  protected static final String derivedLossyImageCompressionColumnName
  See Also:
  
  Constant Field Values
Constructor Details
- DicomDatabaseInformationModel
  
  public DicomDatabaseInformationModel(String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary) throws DicomException
  
  Parameters:
  
  databaseFileName -
  
  rootInformationEntity -
  
  dictionary -
  
  Throws:
  
  DicomException
- DicomDatabaseInformationModel
  
  public DicomDatabaseInformationModel(String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary, String databaseRootName) throws DicomException
  
  Parameters:
  
  databaseFileName -
  
  rootInformationEntity -
  
  dictionary -
  
  databaseRootName -
  
  Throws:
  
  DicomException
- DicomDatabaseInformationModel
  
  public DicomDatabaseInformationModel(String databaseFileName, String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary) throws DicomException
  
  Parameters:
  
  databaseFileName -
  
  rootInformationEntity -
  
  dictionary -
  
  Throws:
  
  DicomException
- DicomDatabaseInformationModel
  
  public DicomDatabaseInformationModel(String databaseFileName, String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary, String databaseRootName) throws DicomException
  
  Parameters:
  
  databaseFileName -
  
  rootInformationEntity -
  
  dictionary -
  
  databaseRootName -
  
  Throws:
  
  DicomException
Method Details
- getNametoDescribeThisInstanceOfInformationEntity
  
  public String getNametoDescribeThisInstanceOfInformationEntity(InformationEntity ie, Map returnedAttributes)
  
  Description copied from class: DatabaseInformationModel
  
  For a particular instance of an information entity, find a descriptive name for the entity suitable for rendering.
  
  For a patient, this might be the name Patient. For an instance, this will depend on the SOPClassUID, and might be an Image, a Waveform, etc.
  
  Specified by:
  
  getNametoDescribeThisInstanceOfInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  ie -
  
  returnedAttributes -
  
  Returns:
  
  a human-readable string name of the entity
- extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the names of the additional search columns derived from person name attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  Specific to each concrete information model extending DatabaseInformationModel.
  
  Specified by:
  
  extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which a select statement is being constructed
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the values of the additional search columns derived from person name attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  Specific to each concrete information model extending DatabaseInformationModel.
  
  Specified by:
  
  extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which a select statement is being constructed
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the names of the attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  The default implementation adds values for all attributes that are present in the database tables and present in the instance.
  
  At the INSTANCE level, InstanceNumber is always added.
  
  At the INSTANCE level, ImageOrientationPatient within PlaneOrientationSequence within SharedFunctionalGroupsSequence is always added, if present.
  
  Specified by:
  
  extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which an insert statement is being constructed
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie, String fileName, String fileReferenceType) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the values of the attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  The default implementation adds values for all attributes that are present in the database tables and present in the instance.
  
  At the INSTANCE level, InstanceNumber is always added.
  
  At the INSTANCE level, ImageOrientationPatient within PlaneOrientationSequence within SharedFunctionalGroupsSequence is always added, if present.
  
  Specified by:
  
  extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which an insert statement is being constructed
  
  fileName - the local filename, which may be non-null for INSTANCE level insertions
  
  fileReferenceType - "C" for copied (i.e., delete on purge), "R" for referenced (i.e., do not delete on purge)
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the names of the derived attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  Specific to each concrete information model extending DatabaseInformationModel.
  
  Specified by:
  
  extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which an insert statement is being constructed
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- getTimestampFromDate
  
  public Timestamp getTimestampFromDate(Date javaDate)
- getDateFromDicomDateAndTime
  
  public Date getDateFromDicomDateAndTime(String date, String time, String timezone)
- getDateFromDicomDateAndTime
  
  public Date getDateFromDicomDateAndTime(String dateTime)
- getTimestampFromDicomDateAndTime
  
  public Timestamp getTimestampFromDicomDateAndTime(String date, String time, String timezone)
- getTimestampFromDicomDateAndTime
  
  public Timestamp getTimestampFromDicomDateAndTime(String sdatetime)
- extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity
  
  protected void extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity(StringBuffer b, AttributeList list, InformationEntity ie) throws DicomException
  
  Extend a SQL INSERT statement in the process of being constructed with the values of the derived attributes in the instance for the entity.
  
  Called when inserting a new record for an instance of the entity.
  
  Specific to each concrete information model extending DatabaseInformationModel.
  
  Specified by:
  
  extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  list - the DICOM attributes of a composite object, containing the attributes describing this instance of the entity
  
  ie - the InformationEntity for which an insert statement is being constructed
  
  Throws:
  
  DicomException - thrown if there are problems extracting the DICOM attributes
- extendCreateStatementStringWithDerivedAttributes
  
  protected void extendCreateStatementStringWithDerivedAttributes(StringBuffer b, InformationEntity ie)
  
  Extend a SQL CREATE TABLE statement in the process of being constructed with any derived attributes (columns) that the model requires.
  
  Called when creating the tables for a new database.
  
  Specific to each concrete information model extending DatabaseInformationModel. Defaults to adding no extra columns if not overridden (i.e. it is not abstract).
  
  For example, there may be dates and times derived from DICOM attributes.
  
  Overrides:
  
  extendCreateStatementStringWithDerivedAttributes in class DatabaseInformationModel
  
  Parameters:
  
  b - the statement being constructed
  
  ie - the InformationEntity for which a create table statement is being constructed
- createPrimaryKeyForSelectedInformationEntity
  
  protected String createPrimaryKeyForSelectedInformationEntity(InformationEntity ie)
  
  Description copied from class: DatabaseInformationModel
  
  Create a new unique key which may be used to identify a new instance of an entity.
  
  Called when inserting a new record for an instance of the entity.
  
  Specified by:
  
  createPrimaryKeyForSelectedInformationEntity in class DatabaseInformationModel
  
  Parameters:
  
  ie -
  
  Returns:
  
  string value of a unique key
- getQuotedValueOrNULL
  
  public static String getQuotedValueOrNULL(String value)
  
  Make a quoted string value suitable for using in a SQL statement from a (possibly null or empty) string.
  
  No attempt at escaping specially characters is made ... this is assumed already done.
  
  Leading or trailing whitespace is trimmed.
  
  Parameters:
  
  value - the string, which may be null or zero length
  
  Returns:
  
  the quoted string value of the attribute, or the (unquoted) string NULL if the value is null or zero length
- getQuotedEscapedSingleStringValueOrNull
  
  public static String getQuotedEscapedSingleStringValueOrNull(Attribute a) throws DicomException
  
  Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
  
  Special characters should be escaped (actually they are just replaced with a hyphen).
  
  Multiple values are collapsed and separated by the usual DICOM backslash delimiter character (which doesn't bother SQL).
  
  Parameters:
  
  a - the DICOM attribute, which may be null, zero length or multi-valued
  
  Returns:
  
  the quoted string value of the attribute, or the (unquoted) string NULL if attribute is absent, has no value or is zero length
  
  Throws:
  
  DicomException
- getQuotedUnescapedSingleStringValueOrNull
  
  public static String getQuotedUnescapedSingleStringValueOrNull(Attribute a) throws DicomException
  
  Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
  
  Does NOT escape special characters.
  
  Multiple values are collapsed and separated by the usual DICOM backslash delimiter character (which doesn't bother SQL).
  
  Parameters:
  
  a - the DICOM attribute, which may be null, zero length or multi-valued
  
  Returns:
  
  the quoted string value of the attribute, or the (unquoted) string NULL if attribute is absent, has no value or is zero length
  
  Throws:
  
  DicomException
- getQuotedSingleStringValueOrNull
  
  public static String getQuotedSingleStringValueOrNull(Attribute a, boolean escapeSpecialCharacters) throws DicomException
  
  Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
  
  Special characters may be escaped (actually they are just replaced with a hyphen).
  
  Multiple values are collapsed and separated by the usual DICOM backslash delimiter character (which doesn't bother SQL).
  
  Leading or trailing whitespace in each value is trimmed.
  
  Parameters:
  
  a - the DICOM attribute, which may be null, zero length or multi-valued
  
  escapeSpecialCharacters - whether or not to escape special characters (currently only single quote)
  
  Returns:
  
  the quoted string value of the attribute, or the (unquoted) string NULL if attribute is absent, has no value or is zero length
  
  Throws:
  
  DicomException
- getQueryResponseGeneratorFactory
  
  public QueryResponseGeneratorFactory getQueryResponseGeneratorFactory()
  
  Get a factory to manufacture a query response generator capable of performing a query and returning the results.
  
  Overrides:
  
  getQueryResponseGeneratorFactory in class DatabaseInformationModel
  
  Returns:
  
  the response generator factory
- getQueryResponseGeneratorFactory
  
  public QueryResponseGeneratorFactory getQueryResponseGeneratorFactory(int debugLevel)
  
  Get a factory to manufacture a query response generator capable of performing a query and returning the results.
  
  Overrides:
  
  getQueryResponseGeneratorFactory in class DatabaseInformationModel
  
  Parameters:
  
  debugLevel - ignored
  
  Returns:
  
  the response generator factory
- getRetrieveResponseGeneratorFactory
  
  public RetrieveResponseGeneratorFactory getRetrieveResponseGeneratorFactory()
  
  Get a factory to manufacture a retrieve response generator capable of performing a retrieve and returning the results.
  
  Overrides:
  
  getRetrieveResponseGeneratorFactory in class DatabaseInformationModel
  
  Returns:
  
  the response generator factory
- getRetrieveResponseGeneratorFactory
  
  public RetrieveResponseGeneratorFactory getRetrieveResponseGeneratorFactory(int debugLevel)
  
  Get a factory to manufacture a retrieve response generator capable of performing a retrieve and returning the results.
  
  Overrides:
  
  getRetrieveResponseGeneratorFactory in class DatabaseInformationModel
  
  Parameters:
  
  debugLevel - ignored
  
  Returns:
  
  the response generator factory

Class DicomDatabaseInformationModel

Field Summary

Fields inherited from class com.pixelmed.database.DatabaseInformationModel

Constructor Summary

Method Summary

Methods inherited from class com.pixelmed.database.DatabaseInformationModel

Methods inherited from class java.lang.Object

Field Details

derivedStudyDateTimeColumnName

derivedSeriesDateTimeColumnName

derivedContentDateTimeColumnName

derivedAcquisitionDateTimeColumnName

derivedLossyImageCompressionColumnName

Constructor Details

DicomDatabaseInformationModel

DicomDatabaseInformationModel

DicomDatabaseInformationModel

DicomDatabaseInformationModel

Method Details

getNametoDescribeThisInstanceOfInformationEntity

extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity

extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity

extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity

extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity

extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity

getTimestampFromDate

getDateFromDicomDateAndTime

getDateFromDicomDateAndTime

getTimestampFromDicomDateAndTime

getTimestampFromDicomDateAndTime

extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity

extendCreateStatementStringWithDerivedAttributes

createPrimaryKeyForSelectedInformationEntity

getQuotedValueOrNULL

getQuotedEscapedSingleStringValueOrNull

getQuotedUnescapedSingleStringValueOrNull

getQuotedSingleStringValueOrNull

getQueryResponseGeneratorFactory

getQueryResponseGeneratorFactory

getRetrieveResponseGeneratorFactory

getRetrieveResponseGeneratorFactory