org.dcm4chee.xds2.registry.ws.query

Class StoredQuery

java.lang.Object

org.dcm4chee.xds2.registry.ws.query.StoredQuery

Direct Known Subclasses:

FindDocumentsQuery, FindFoldersQuery, FindSubmissionSetQuery, GetAllQuery, GetAssociationsQuery, GetDocumentsAndAssociationsQuery, GetDocumentsQuery, GetFolderAndContentsQuery, GetFoldersForDocumentQuery, GetFoldersQuery, GetRelatedDocumentsQuery, GetSubmissionSetAndContentsQuery, GetSubmissionSetsQuery, XdsDummyQuery

public abstract class StoredQuery
extends Object

Interface for StoredQuery

Author:

franz.willer@gmail.com

Constructor Summary

Constructors

Constructor and Description
StoredQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, XDSRegistryBean session)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFromToMatch(com.mysema.query.BooleanBuilder builder, StoredQueryParam fromParam, StoredQueryParam toParam, com.mysema.query.types.path.NumberPath<Long> subselectJoinPk, String slotName)
protected void	addIndexMatch(com.mysema.query.BooleanBuilder builder, com.mysema.query.types.path.NumberPath<Long> registryObjectPk, StoredQueryParam param, org.dcm4chee.xds2.persistence.RegistryObject.XDSSearchIndexKey key) Adds a match against RegistryObjectIndex, i.e.
protected void	addPatientIdMatch(com.mysema.query.BooleanBuilder builder, StoredQueryParam pid)
protected void	addSlotValueMatch(com.mysema.query.BooleanBuilder builder, StoredQueryParam param, String slotName, com.mysema.query.types.path.NumberPath<Long> subselectJoinPk)
protected void	addStatusMatch(com.mysema.query.BooleanBuilder builder, com.mysema.query.types.path.StringPath status, StoredQueryParam statusParam)
protected void	addXdsCodeMatch(com.mysema.query.BooleanBuilder builder, StoredQueryParam codeParam, String codeClassification, com.mysema.query.types.path.CollectionPath<org.dcm4chee.xds2.persistence.XDSCode,org.dcm4chee.xds2.persistence.QXDSCode> xdsCodes) Add code matches in XDS form using XDSCode entity
protected void	checkRequiredParameter()
protected org.dcm4chee.xds2.persistence.XDSDocumentEntry	getDocumentEntry()
protected List<org.dcm4chee.xds2.persistence.Identifiable>	getObjectsFor(org.dcm4chee.xds2.persistence.RegistryObject ro)
String	getPatientID()
StoredQueryParam	getQueryParam(String name)
org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest	getRequest()
abstract String[]	getRequiredParameterNames() Get list of required parameter names for this Stored Query.
XDSRegistryBean	getSession()
static StoredQuery	getStoredQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, XDSRegistryBean session)
protected org.dcm4chee.xds2.infoset.rim.AdhocQueryResponse	initAdhocQueryResponse()
boolean	isLeafClass()
abstract org.dcm4chee.xds2.infoset.rim.AdhocQueryResponse	query()
protected String[]	toCodeValueAndScheme(String codeString)

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredQuery

public StoredQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
           XDSRegistryBean session)
            throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

Method Detail

query

public abstract org.dcm4chee.xds2.infoset.rim.AdhocQueryResponse query()
                                                                throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

getRequiredParameterNames

public abstract String[] getRequiredParameterNames()

Get list of required parameter names for this Stored Query. For a 'one of name1 or name2 or ..' you can specify "name1|name2" e.g.: a) {"$XDSDocumentEntryUniqueId|$XDSDocumentEntryEntryUUID"}: one of $XDSDocumentEntryUniqueId or $XDSDocumentEntryEntryUUID must be set b) {"$XDSDocumentEntryPatientId", "$XDSDocumentEntryStatus"} $XDSDocumentEntryPatientId AND $XDSDocumentEntryStatus must be set

Returns:

getRequest

public org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest getRequest()

getSession

public XDSRegistryBean getSession()

getPatientID

public String getPatientID()

getStoredQuery

public static StoredQuery getStoredQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
                         XDSRegistryBean session)
                                  throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

getQueryParam

public StoredQueryParam getQueryParam(String name)

isLeafClass

public boolean isLeafClass()

initAdhocQueryResponse

protected org.dcm4chee.xds2.infoset.rim.AdhocQueryResponse initAdhocQueryResponse()

checkRequiredParameter

protected void checkRequiredParameter()
                               throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

addPatientIdMatch

protected void addPatientIdMatch(com.mysema.query.BooleanBuilder builder,
                     StoredQueryParam pid)
                          throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

addStatusMatch

protected void addStatusMatch(com.mysema.query.BooleanBuilder builder,
                  com.mysema.query.types.path.StringPath status,
                  StoredQueryParam statusParam)

addXdsCodeMatch

protected void addXdsCodeMatch(com.mysema.query.BooleanBuilder builder,
                   StoredQueryParam codeParam,
                   String codeClassification,
                   com.mysema.query.types.path.CollectionPath<org.dcm4chee.xds2.persistence.XDSCode,org.dcm4chee.xds2.persistence.QXDSCode> xdsCodes)
                        throws org.dcm4chee.xds2.common.exception.XDSException

Add code matches in XDS form using XDSCode entity

Parameters:

builder - BooleanBuilder to add matches for given code parameter

codeParam - Stored Query Parameter with code values

codeType - The classification of the codes (Classification.classificationScheme)

xdsCodes - The CollectionPath for XDSCodes of parent select (to bind subselect)

Throws:

org.dcm4chee.xds2.common.exception.XDSException

addFromToMatch

protected void addFromToMatch(com.mysema.query.BooleanBuilder builder,
                  StoredQueryParam fromParam,
                  StoredQueryParam toParam,
                  com.mysema.query.types.path.NumberPath<Long> subselectJoinPk,
                  String slotName)

addSlotValueMatch

protected void addSlotValueMatch(com.mysema.query.BooleanBuilder builder,
                     StoredQueryParam param,
                     String slotName,
                     com.mysema.query.types.path.NumberPath<Long> subselectJoinPk)

addIndexMatch

protected void addIndexMatch(com.mysema.query.BooleanBuilder builder,
                 com.mysema.query.types.path.NumberPath<Long> registryObjectPk,
                 StoredQueryParam param,
                 org.dcm4chee.xds2.persistence.RegistryObject.XDSSearchIndexKey key)

Adds a match against RegistryObjectIndex, i.e. the indexed fields from the blob xml.
Uses OR for multi values and LIKE to match.

toCodeValueAndScheme

protected String[] toCodeValueAndScheme(String codeString)
                                 throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

getDocumentEntry

protected org.dcm4chee.xds2.persistence.XDSDocumentEntry getDocumentEntry()
                                                                   throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException

getObjectsFor

protected List<org.dcm4chee.xds2.persistence.Identifiable> getObjectsFor(org.dcm4chee.xds2.persistence.RegistryObject ro)
                                                                  throws org.dcm4chee.xds2.common.exception.XDSException

Throws:

org.dcm4chee.xds2.common.exception.XDSException