org.openmrs.web.controller.encounter

Class EncounterDisplayController.FieldHolder

java.lang.Object

org.openmrs.web.controller.encounter.EncounterDisplayController.FieldHolder

All Implemented Interfaces:

java.lang.Comparable<EncounterDisplayController.FieldHolder>

Enclosing class:

EncounterDisplayController

public class EncounterDisplayController.FieldHolder
extends java.lang.Object
implements java.lang.Comparable<EncounterDisplayController.FieldHolder>

This class represents one row to display on the jsp page

Constructor Summary

Constructors

Constructor and Description
FieldHolder(FormField formField, Obs obsToAdd) A row must be created with both a FormField to act as its label and an obs that is the first of possibly several rows to display

Method Summary

Modifier and Type	Method and Description
void	addObservation(Obs obsToAdd) Add another obs grouper to this row This method shouldn't be called with obs that are within another grouped obs.
int	compareTo(EncounterDisplayController.FieldHolder other) Use this row's FormField to make comparisons about where to put it in relation to the FieldHolder's
FormField	getFormField() public getter method for the formfield that is the label for this row
java.util.Set<Concept>	getGroupMemberConcepts() public getter for the columns (that are unique concepts across all obs in this FieldHolder)
java.lang.String	getLabel() Convenience method to get the label that this field should have.
java.util.List<Obs>	getObs() public getter for the obs that are the different rows for this FieldHolder.
java.util.Map<Obs,java.util.List<java.util.List<Obs>>>	getObsGroupMatrix() List of columns for each obs grouper in this fieldholder.
java.lang.Integer	getPageNumber() Convenience method to get the page number for this row.
boolean	isObsGrouping() Convenience method to know whether this row is an obs grouping and should be displayed with a table or if its a single one-and-done obs and should just be shown as one value

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldHolder

public FieldHolder(FormField formField,
                   Obs obsToAdd)
            throws java.lang.Exception

A row must be created with both a FormField to act as its label and an obs that is the first of possibly several rows to display

Throws:

java.lang.Exception - if the obsToAdd is an invalid type (meaning its contained in another obs group)

Method Detail

getFormField

public FormField getFormField()

public getter method for the formfield that is the label for this row

Returns:

FormField for this row

getGroupMemberConcepts

public java.util.Set<Concept> getGroupMemberConcepts()

public getter for the columns (that are unique concepts across all obs in this FieldHolder)

Returns:

unique concepts across these obs

getObs

public java.util.List<Obs> getObs()

public getter for the obs that are the different rows for this FieldHolder. If this isn't a grouping type of row, the set could still have multiple obs in it because there are multiple questions (obs) in this encounter that are asking the same thing (same concept)

Returns:

List of obs for this row

isObsGrouping

public boolean isObsGrouping()

Convenience method to know whether this row is an obs grouping and should be displayed with a table or if its a single one-and-done obs and should just be shown as one value

Returns:

true/false whether this holder is for an obs grouping

getObsGroupMatrix

public java.util.Map<Obs,java.util.List<java.util.List<Obs>>> getObsGroupMatrix()

List of columns for each obs grouper in this fieldholder. Not every grouper will have every column (concept), so some cells will be null. The columns are determined by getObsGroupConcepts()

Returns:

a matrix of columns

addObservation

public void addObservation(Obs obsToAdd)

Add another obs grouper to this row This method shouldn't be called with obs that are within another grouped obs. This should only be called with the parent obs grouper.

Parameters:

obsToAdd - Obs that should be an obs grouper

compareTo

public int compareTo(EncounterDisplayController.FieldHolder other)

Use this row's FormField to make comparisons about where to put it in relation to the FieldHolder's

Specified by:

compareTo in interface java.lang.Comparable<EncounterDisplayController.FieldHolder>

See Also:

FormField.compareTo(org.openmrs.FormField)

getLabel

public java.lang.String getLabel()

Convenience method to get the label that this field should have. This is produced from the formfield associated with this row

Returns:

String representing the label to be displayed for this row

getPageNumber

public java.lang.Integer getPageNumber()

Convenience method to get the page number for this row. This just checks the associated form field for its assigned page number. If the formfield doesn't have a page, this row is thrown on the DEFAULT_PAGE_NUMBERth page.

Returns:

page number for this row