org.openmrs.api.db.hibernate

Class HibernateFormDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateFormDAO

All Implemented Interfaces:

FormDAO

public class HibernateFormDAO
extends Object
implements FormDAO

Hibernate-specific Form-related functions. This class should not be used directly. All calls should go through the FormService methods.

See Also:

FormDAO, FormService

Constructor Summary

Constructors

Constructor and Description
HibernateFormDAO()

Method Summary

Modifier and Type	Method and Description
void	deleteField(Field field) Deletes a field from the database.
void	deleteFieldType(FieldType fieldType) Delete the given field type from the database
void	deleteForm(Form form) Delete form from database.
void	deleteFormField(FormField formField) Deletes a FormField from the database.
void	deleteFormResource(FormResource formResource)
Form	duplicateForm(Form form) Creates new form from the given Form
List<Field>	getAllFields(boolean includeRetired) Returns all fields in the database, possibly including retired ones
List<FieldType>	getAllFieldTypes(boolean includeRetired) Get all field types
List<FormField>	getAllFormFields() Returns all FormFields in the database
List<Form>	getAllForms(boolean includeRetired) Returns all forms in the database, possibly including retired ones
Field	getField(Integer fieldId)
FieldAnswer	getFieldAnswerByUuid(String uuid)
Field	getFieldByUuid(String uuid)
List<Field>	getFields(Collection<Form> forms, Collection<FieldType> fieldTypes, Collection<Concept> concepts, Collection<String> tableNames, Collection<String> attributeNames, Boolean selectMultiple, Collection<FieldAnswer> containsAllAnswers, Collection<FieldAnswer> containsAnyAnswer, Boolean retired) Returns all fields that match a broad range of (nullable) criteria
List<Field>	getFields(String search)
List<Field>	getFieldsByConcept(Concept concept)
FieldType	getFieldType(Integer fieldTypeId) Get fieldType by internal identifier
FieldType	getFieldTypeByName(String name) Return fieldType associated with given name
FieldType	getFieldTypeByUuid(String uuid)
Form	getForm(Integer formId) Get form by internal form identifier
Form	getForm(String name, String version) Get form by exact name and version
Form	getFormByUuid(String uuid)
Integer	getFormCount(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields)
FormField	getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)
FormField	getFormField(Integer formFieldId)
FormField	getFormFieldByUuid(String uuid)
List<FormField>	getFormFields(Form form)
List<FormField>	getFormFieldsByField(Field field) Return a list of FormFields given a Field
FormResource	getFormResource(Form form, String name)
FormResource	getFormResource(Integer formResourceId)
FormResource	getFormResourceByUuid(String uuid)
Collection<FormResource>	getFormResourcesForForm(Form form)
List<Form>	getForms(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields) Gets all forms that match all the criteria.
List<Form>	getFormsByName(String name) Gets all forms with the given name, sorted (alphabetically) by descending version
List<Form>	getFormsContainingConcept(Concept c) Get all forms that contain the given Concept as one of their fields.
Field	saveField(Field field)
FieldType	saveFieldType(FieldType fieldType) Save the given field type to the database
Form	saveForm(Form form) Returns the form object originally passed in, which will have been persisted.
FormField	saveFormField(FormField formField)
FormResource	saveFormResource(FormResource formResource)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set session factory

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateFormDAO

public HibernateFormDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

saveForm

public Form saveForm(Form form)
              throws DAOException

Returns the form object originally passed in, which will have been persisted.

Specified by:

saveForm in interface FormDAO

Throws:

DAOException

See Also:

org.openmrs.api.FormService#createForm(org.openmrs.Form)

duplicateForm

public Form duplicateForm(Form form)
                   throws DAOException

Description copied from interface: FormDAO

Creates new form from the given Form

Specified by:

duplicateForm in interface FormDAO

Parameters:

form - Form to duplicate

Returns:

newly duplicated Form

Throws:

DAOException

See Also:

FormService.duplicateForm(org.openmrs.Form)

deleteForm

public void deleteForm(Form form)
                throws DAOException

Description copied from interface: FormDAO

Delete form from database. This is included for troubleshooting and low-level system administration. Ideally, this method should never be called — Forms should be retired and not deleted altogether (since many foreign key constraints depend on forms, deleting a form would require deleting all traces, and any historical trail would be lost). This method only clears form roles and attempts to delete the form record. If the form has been included in any other parts of the database (through a foreign key), the attempt to delete the form will violate foreign key constraints and fail.

Specified by:

deleteForm in interface FormDAO

Parameters:

form - Form to delete

Throws:

DAOException

See Also:

org.openmrs.api.FormService#deleteForm(org.openmrs.Form)

getForm

public Form getForm(Integer formId)
             throws DAOException

Description copied from interface: FormDAO

Get form by internal form identifier

Specified by:

getForm in interface FormDAO

Parameters:

formId - Integer internal identifier for requested Form

Returns:

requested Form

Throws:

DAOException

See Also:

FormService.getForm(java.lang.Integer)

getFormFields

public List<FormField> getFormFields(Form form)

See Also:

org.openmrs.api.FormService#getFormFields(Form)

getFields

public List<Field> getFields(String search)

Specified by:

getFields in interface FormDAO

Parameters:

search - String phrase to search for

Returns:

list of fields in the database matching search phrase

See Also:

FormDAO.getFields(java.lang.String)

getFieldsByConcept

public List<Field> getFieldsByConcept(Concept concept)

See Also:

FormService.getFieldsByConcept(org.openmrs.Concept)

getField

public Field getField(Integer fieldId)
               throws DAOException

Specified by:

getField in interface FormDAO

Throws:

DAOException

See Also:

FormService.getField(java.lang.Integer), FormDAO.getField(java.lang.Integer)

getAllFields

public List<Field> getAllFields(boolean includeRetired)
                         throws DAOException

Description copied from interface: FormDAO

Returns all fields in the database, possibly including retired ones

Specified by:

getAllFields in interface FormDAO

Parameters:

includeRetired - whether or not to return retired fields

Returns:

all fields in the database, possibly including retired ones

Throws:

DAOException

See Also:

FormService.getAllFields(boolean), FormDAO.getAllFields(boolean)

getFieldType

public FieldType getFieldType(Integer fieldTypeId)
                       throws DAOException

Description copied from interface: FormDAO

Get fieldType by internal identifier

Specified by:

getFieldType in interface FormDAO

Parameters:

fieldTypeId - Internal Integer identifier of FieldType

Returns:

The FieldType with specified internal identifier

Throws:

DAOException

See Also:

FormService.getFieldType(java.lang.Integer), FormDAO.getFieldType(java.lang.Integer)

getAllFieldTypes

public List<FieldType> getAllFieldTypes(boolean includeRetired)

Description copied from interface: FormDAO

Get all field types

Specified by:

getAllFieldTypes in interface FormDAO

Parameters:

includeRetired - boolean - include retired field types as well?

Returns:

List<FieldTypes> object with all FieldTypes, possibly including retired ones

See Also:

org.openmrs.api.FormService#getFieldTypes(), FormDAO.getAllFieldTypes(boolean)

getFormField

public FormField getFormField(Integer formFieldId)
                       throws DAOException

Specified by:

getFormField in interface FormDAO

Throws:

DAOException

See Also:

FormService.getFormField(java.lang.Integer), FormDAO.getFormField(java.lang.Integer)

getFormField

public FormField getFormField(Form form,
                              Concept concept,
                              Collection<FormField> ignoreFormFields,
                              boolean force)
                       throws DAOException

Specified by:

getFormField in interface FormDAO

Throws:

DAOException

See Also:

FormService.getFormField(org.openmrs.Form, org.openmrs.Concept, java.util.Collection, boolean), FormDAO.getFormField(org.openmrs.Form, org.openmrs.Concept, java.util.Collection, boolean)

getAllForms

public List<Form> getAllForms(boolean includeRetired)

Description copied from interface: FormDAO

Returns all forms in the database, possibly including retired ones

Specified by:

getAllForms in interface FormDAO

Parameters:

includeRetired - boolean - include retired forms?

Returns:

List<Form> object of all forms, possibly including retired ones

See Also:

org.openmrs.api.FormService#getForms()

getFormsContainingConcept

public List<Form> getFormsContainingConcept(Concept c)
                                     throws DAOException

Description copied from interface: FormDAO

Get all forms that contain the given Concept as one of their fields. (Includes retired forms.)

Specified by:

getFormsContainingConcept in interface FormDAO

Parameters:

c - the Concept to search through form fields for

Returns:

forms that contain a form field referencing the given concept

Throws:

DAOException

See Also:

FormDAO.getFormsContainingConcept(org.openmrs.Concept)

saveField

public Field saveField(Field field)
                throws DAOException

Specified by:

saveField in interface FormDAO

Throws:

DAOException

See Also:

FormService.saveField(org.openmrs.Field), FormDAO.saveField(org.openmrs.Field)

deleteField

public void deleteField(Field field)
                 throws DAOException

Description copied from interface: FormDAO

Deletes a field from the database.

This will fail if any other entities reference this field via a foreign key

Specified by:

deleteField in interface FormDAO

Parameters:

field - the Field to delete

Throws:

DAOException

See Also:

org.openmrs.api.FormService#deleteField(org.openmrs.Field), FormDAO.deleteField(org.openmrs.Field)

saveFormField

public FormField saveFormField(FormField formField)
                        throws DAOException

Specified by:

saveFormField in interface FormDAO

Throws:

DAOException

See Also:

org.openmrs.api.FormService#createFormField(org.openmrs.FormField)

deleteFormField

public void deleteFormField(FormField formField)
                     throws DAOException

Description copied from interface: FormDAO

Deletes a FormField from the database. This will fail if any other entities reference this FormField via a foreign key

Specified by:

deleteFormField in interface FormDAO

Parameters:

formField - the FormField to delete

Throws:

DAOException

See Also:

org.openmrs.api.FormService#deleteFormField(org.openmrs.FormField), FormDAO.deleteFormField(org.openmrs.FormField)

getAllFormFields

public List<FormField> getAllFormFields()

Description copied from interface: FormDAO

Returns all FormFields in the database

Specified by:

getAllFormFields in interface FormDAO

Returns:

List<FormField> object of all FormFields in the database

See Also:

FormDAO.getAllFormFields()

getFields

public List<Field> getFields(Collection<Form> forms,
                             Collection<FieldType> fieldTypes,
                             Collection<Concept> concepts,
                             Collection<String> tableNames,
                             Collection<String> attributeNames,
                             Boolean selectMultiple,
                             Collection<FieldAnswer> containsAllAnswers,
                             Collection<FieldAnswer> containsAnyAnswer,
                             Boolean retired)
                      throws DAOException

Description copied from interface: FormDAO

Returns all fields that match a broad range of (nullable) criteria

Specified by:

getFields in interface FormDAO

Parameters:

forms - Collection of Form to which the requested Fields must belong

fieldTypes - Collection of FieldType of which the requested fields must be

concepts - Collection of Concepts which the fields must point to

tableNames - Collection of TableNames which the fields must point to

attributeNames - Collection of String attribute names which the fields must point to

selectMultiple - Boolean value that matching fields must have for selectMultiple

containsAllAnswers - Collection of FieldAnswers, all of which a matching field must contain (not yet implemented)

containsAnyAnswer - Collection of FieldAnswers, any one of which a matching field must contain (not yet implemented)

retired - Boolean retired status that fields must match

Returns:

All Fields that match the criteria

Throws:

DAOException

See Also:

FormDAO.getFields(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.lang.Boolean, java.util.Collection, java.util.Collection, java.lang.Boolean)

getForm

public Form getForm(String name,
                    String version)

Description copied from interface: FormDAO

Get form by exact name and version

Specified by:

getForm in interface FormDAO

Parameters:

name - the name of the form to get

version - the version of the form to get

Returns:

the form with the exact name and version given

See Also:

FormDAO.getForm(java.lang.String, java.lang.String)

getForms

public List<Form> getForms(String partialName,
                           Boolean published,
                           Collection<EncounterType> encounterTypes,
                           Boolean retired,
                           Collection<FormField> containingAnyFormField,
                           Collection<FormField> containingAllFormFields,
                           Collection<Field> fields)
                    throws DAOException

Description copied from interface: FormDAO

Gets all forms that match all the criteria. Expects the list objects to be non-null

Specified by:

getForms in interface FormDAO

Parameters:

partialName - String of partial name of form to search on

published - boolean - is the form published?

encounterTypes - Collection of EncounterTypes that the form must represent

retired - boolean - is the form retired?

containingAnyFormField - Collection of FormFields, any one of which must be contained in the form

containingAllFormFields - Collection of FormFields, all of which must be contained in the form

fields - Collection of Fields that the form must contain

Returns:

All forms that match the criteria

Throws:

DAOException

See Also:

FormDAO.getForms(java.lang.String, java.lang.Boolean, java.util.Collection, java.lang.Boolean, java.util.Collection, java.util.Collection, java.util.Collection)

getFormCount

public Integer getFormCount(String partialName,
                            Boolean published,
                            Collection<EncounterType> encounterTypes,
                            Boolean retired,
                            Collection<FormField> containingAnyFormField,
                            Collection<FormField> containingAllFormFields,
                            Collection<Field> fields)
                     throws DAOException

Specified by:

getFormCount in interface FormDAO

Throws:

DAOException

See Also:

FormDAO.getFormCount(java.lang.String, java.lang.Boolean, java.util.Collection, java.lang.Boolean, java.util.Collection, java.util.Collection, java.util.Collection)

getFieldByUuid

public Field getFieldByUuid(String uuid)

Specified by:

getFieldByUuid in interface FormDAO

Returns:

field or null

See Also:

FormDAO.getFieldByUuid(java.lang.String)

getFieldAnswerByUuid

public FieldAnswer getFieldAnswerByUuid(String uuid)

Specified by:

getFieldAnswerByUuid in interface FormDAO

getFieldTypeByUuid

public FieldType getFieldTypeByUuid(String uuid)

Specified by:

getFieldTypeByUuid in interface FormDAO

Returns:

field type or null

See Also:

FormDAO.getFieldTypeByUuid(java.lang.String)

getFieldTypeByName

public FieldType getFieldTypeByName(String name)

Description copied from interface: FormDAO

Return fieldType associated with given name

Specified by:

getFieldTypeByName in interface FormDAO

Parameters:

name - Name of the fileType to query

Returns:

fieldType object associate with given name

See Also:

FormDAO.getFieldTypeByName(java.lang.String)

getFormByUuid

public Form getFormByUuid(String uuid)

Specified by:

getFormByUuid in interface FormDAO

Returns:

form or null

See Also:

FormDAO.getFormByUuid(java.lang.String)

getFormFieldByUuid

public FormField getFormFieldByUuid(String uuid)

Specified by:

getFormFieldByUuid in interface FormDAO

Returns:

form field or null

See Also:

FormDAO.getFormFieldByUuid(java.lang.String)

getFormsByName

public List<Form> getFormsByName(String name)
                          throws DAOException

Description copied from interface: FormDAO

Gets all forms with the given name, sorted (alphabetically) by descending version

Specified by:

getFormsByName in interface FormDAO

Parameters:

name - String name of the forms to get

Returns:

All forms with the given name, sorted by (alphabetically) by descending version

Throws:

DAOException

See Also:

FormDAO.getFormsByName(java.lang.String)

deleteFieldType

public void deleteFieldType(FieldType fieldType)
                     throws DAOException

Description copied from interface: FormDAO

Delete the given field type from the database

Specified by:

deleteFieldType in interface FormDAO

Parameters:

fieldType - FieldType to delete

Throws:

DAOException

See Also:

FormDAO.deleteFieldType(org.openmrs.FieldType)

saveFieldType

public FieldType saveFieldType(FieldType fieldType)
                        throws DAOException

Description copied from interface: FormDAO

Save the given field type to the database

Specified by:

saveFieldType in interface FormDAO

Parameters:

fieldType - FieldType to save to the database

Returns:

the newly saved field type

Throws:

DAOException

See Also:

FormDAO.saveFieldType(org.openmrs.FieldType)

getFormFieldsByField

public List<FormField> getFormFieldsByField(Field field)

Description copied from interface: FormDAO

Return a list of FormFields given a Field

Specified by:

getFormFieldsByField in interface FormDAO

Returns:

List of FormFields

See Also:

FormDAO.getFormFieldsByField(Field)

getFormResource

public FormResource getFormResource(Integer formResourceId)

Specified by:

getFormResource in interface FormDAO

See Also:

FormDAO.getFormResource(java.lang.Integer)

getFormResourceByUuid

public FormResource getFormResourceByUuid(String uuid)

Specified by:

getFormResourceByUuid in interface FormDAO

See Also:

FormDAO.getFormResourceByUuid(java.lang.String)

getFormResource

public FormResource getFormResource(Form form,
                                    String name)

Specified by:

getFormResource in interface FormDAO

See Also:

FormDAO.getFormResource(org.openmrs.Form, java.lang.String)

saveFormResource

public FormResource saveFormResource(FormResource formResource)

Specified by:

saveFormResource in interface FormDAO

See Also:

FormDAO.saveFormResource(org.openmrs.FormResource)

deleteFormResource

public void deleteFormResource(FormResource formResource)

Specified by:

deleteFormResource in interface FormDAO

See Also:

FormDAO.deleteFormResource(org.openmrs.FormResource)

getFormResourcesForForm

public Collection<FormResource> getFormResourcesForForm(Form form)

Specified by:

getFormResourcesForForm in interface FormDAO

See Also:

FormDAO.getFormResourcesForForm(org.openmrs.Form)