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.
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
derivedAcquisitionDateTimeColumnName |
protected static java.lang.String |
derivedContentDateTimeColumnName |
protected static java.lang.String |
derivedLossyImageCompressionColumnName |
protected static java.lang.String |
derivedSeriesDateTimeColumnName |
protected static java.lang.String |
derivedStudyDateTimeColumnName |
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 and Description |
---|
DicomDatabaseInformationModel(java.lang.String databaseFileName,
InformationEntity rootInformationEntity,
DicomDictionary dictionary) |
DicomDatabaseInformationModel(java.lang.String databaseFileName,
InformationEntity rootInformationEntity,
DicomDictionary dictionary,
java.lang.String databaseRootName) |
DicomDatabaseInformationModel(java.lang.String databaseFileName,
java.lang.String databaseServerName,
InformationEntity rootInformationEntity,
DicomDictionary dictionary) |
DicomDatabaseInformationModel(java.lang.String databaseFileName,
java.lang.String databaseServerName,
InformationEntity rootInformationEntity,
DicomDictionary dictionary,
java.lang.String databaseRootName) |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
createPrimaryKeyForSelectedInformationEntity(InformationEntity ie)
Create a new unique key which may be used to identify a new instance of an entity.
|
protected void |
extendCreateStatementStringWithDerivedAttributes(java.lang.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(java.lang.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(java.lang.StringBuffer b,
AttributeList list,
InformationEntity ie,
java.lang.String fileName,
java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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.
|
java.util.Date |
getDateFromDicomDateAndTime(java.lang.String dateTime) |
java.util.Date |
getDateFromDicomDateAndTime(java.lang.String date,
java.lang.String time,
java.lang.String timezone) |
java.lang.String |
getNametoDescribeThisInstanceOfInformationEntity(InformationEntity ie,
java.util.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.
|
static java.lang.String |
getQuotedEscapedSingleStringValueOrNull(Attribute a)
Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
|
static java.lang.String |
getQuotedSingleStringValueOrNull(Attribute a,
boolean escapeSpecialCharacters)
Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
|
static java.lang.String |
getQuotedUnescapedSingleStringValueOrNull(Attribute a)
Make a quoted string value suitable for using in a SQL statement from a DICOM attribute.
|
static java.lang.String |
getQuotedValueOrNULL(java.lang.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.
|
java.sql.Timestamp |
getTimestampFromDate(java.util.Date javaDate) |
java.sql.Timestamp |
getTimestampFromDicomDateAndTime(java.lang.String sdatetime) |
java.sql.Timestamp |
getTimestampFromDicomDateAndTime(java.lang.String date,
java.lang.String time,
java.lang.String timezone) |
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
protected static final java.lang.String derivedAcquisitionDateTimeColumnName
protected static final java.lang.String derivedContentDateTimeColumnName
protected static final java.lang.String derivedLossyImageCompressionColumnName
protected static final java.lang.String derivedSeriesDateTimeColumnName
protected static final java.lang.String derivedStudyDateTimeColumnName
public DicomDatabaseInformationModel(java.lang.String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary) throws DicomException
databaseFileName
- rootInformationEntity
- dictionary
- DicomException
public DicomDatabaseInformationModel(java.lang.String databaseFileName, InformationEntity rootInformationEntity, DicomDictionary dictionary, java.lang.String databaseRootName) throws DicomException
databaseFileName
- rootInformationEntity
- dictionary
- databaseRootName
- DicomException
public DicomDatabaseInformationModel(java.lang.String databaseFileName, java.lang.String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary) throws DicomException
databaseFileName
- rootInformationEntity
- dictionary
- DicomException
public DicomDatabaseInformationModel(java.lang.String databaseFileName, java.lang.String databaseServerName, InformationEntity rootInformationEntity, DicomDictionary dictionary, java.lang.String databaseRootName) throws DicomException
databaseFileName
- rootInformationEntity
- dictionary
- databaseRootName
- DicomException
protected java.lang.String createPrimaryKeyForSelectedInformationEntity(InformationEntity ie)
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.
createPrimaryKeyForSelectedInformationEntity
in class DatabaseInformationModel
ie
- protected void extendCreateStatementStringWithDerivedAttributes(java.lang.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.
extendCreateStatementStringWithDerivedAttributes
in class DatabaseInformationModel
b
- the statement being constructedie
- the InformationEntity
for which a create table statement is being constructedprotected void extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity(java.lang.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.
extendInsertStatementStringWithAttributeNamesForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which an insert statement is being constructedDicomException
- thrown if there are problems extracting the DICOM attributesprotected void extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity(java.lang.StringBuffer b, AttributeList list, InformationEntity ie, java.lang.String fileName, java.lang.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.
extendInsertStatementStringWithAttributeValuesForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which an insert statement is being constructedfileName
- the local filename, which may be non-null for INSTANCE
level insertionsfileReferenceType
- "C" for copied (i.e., delete on purge), "R" for referenced (i.e., do not delete on purge)DicomException
- thrown if there are problems extracting the DICOM attributesprotected void extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity(java.lang.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
.
extendInsertStatementStringWithDerivedAttributeNamesForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which an insert statement is being constructedDicomException
- thrown if there are problems extracting the DICOM attributesprotected void extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity(java.lang.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
.
extendInsertStatementStringWithDerivedAttributeValuesForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which an insert statement is being constructedDicomException
- thrown if there are problems extracting the DICOM attributesprotected void extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity(java.lang.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
.
extendInsertStatementStringWithPersonNameSearchColumnsForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which a select statement is being constructedDicomException
- thrown if there are problems extracting the DICOM attributesprotected void extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity(java.lang.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
.
extendInsertStatementStringWithPersonNameSearchValuesForSelectedInformationEntity
in class DatabaseInformationModel
b
- the statement being constructedlist
- the DICOM attributes of a composite object, containing the attributes describing this instance of the entityie
- the InformationEntity
for which a select statement is being constructedDicomException
- thrown if there are problems extracting the DICOM attributespublic java.util.Date getDateFromDicomDateAndTime(java.lang.String dateTime)
public java.util.Date getDateFromDicomDateAndTime(java.lang.String date, java.lang.String time, java.lang.String timezone)
public java.lang.String getNametoDescribeThisInstanceOfInformationEntity(InformationEntity ie, java.util.Map returnedAttributes)
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.
getNametoDescribeThisInstanceOfInformationEntity
in class DatabaseInformationModel
ie
- returnedAttributes
- public QueryResponseGeneratorFactory getQueryResponseGeneratorFactory()
Get a factory to manufacture a query response generator capable of performing a query and returning the results.
getQueryResponseGeneratorFactory
in class DatabaseInformationModel
public static java.lang.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).
a
- the DICOM attribute, which may be null, zero length or multi-valuedDicomException
public static java.lang.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.
a
- the DICOM attribute, which may be null, zero length or multi-valuedescapeSpecialCharacters
- whether or not to escape special characters (currently only single quote)DicomException
public static java.lang.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).
a
- the DICOM attribute, which may be null, zero length or multi-valuedDicomException
public static java.lang.String getQuotedValueOrNULL(java.lang.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.
value
- the string, which may be null or zero lengthpublic RetrieveResponseGeneratorFactory getRetrieveResponseGeneratorFactory()
Get a factory to manufacture a retrieve response generator capable of performing a retrieve and returning the results.
getRetrieveResponseGeneratorFactory
in class DatabaseInformationModel
public java.sql.Timestamp getTimestampFromDate(java.util.Date javaDate)
public java.sql.Timestamp getTimestampFromDicomDateAndTime(java.lang.String sdatetime)
public java.sql.Timestamp getTimestampFromDicomDateAndTime(java.lang.String date, java.lang.String time, java.lang.String timezone)