FormatTag (OpenMRS 2.0.0-SNAPSHOT API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - org.openmrs.web.taglib.FormatTag

All Implemented Interfaces:: Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class FormatTag
extends javax.servlet.jsp.tagext.TagSupport

 Prints out a pretty-formatted versions of an OpenMRS object
 TODO: add the other openmrs domain objects
 TODO: add a size=compact|NORMAL|full|? option

See Also:: Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor and Description

FormatTag()

Constructors
Constructor and Description
`FormatTag()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doEndTag()`
`int`	`doStartTag()`
`String`	`getCaseConversion()`
`Concept`	`getConcept()`
`Integer`	`getConceptId()`
`Encounter`	`getEncounter()`
`Integer`	`getEncounterId()`
`Map<EncounterRole,Set<Provider>>`	`getEncounterProviders()`
`EncounterType`	`getEncounterType()`
`Integer`	`getEncounterTypeId()`
`Form`	`getForm()`
`Boolean`	`getJavaScriptEscape()`
`Location`	`getLocation()`
`Integer`	`getLocationId()`
`LocationTag`	`getLocationTag()`
`Integer`	`getLocationTagId()`
`Object`	`getObject()` Gets the object property
`Obs`	`getObsValue()`
`Person`	`getPerson()`
`Integer`	`getPersonId()`
`Program`	`getProgram()`
`Integer`	`getProgramId()`
`SingleCustomValue<?>`	`getSingleCustomValue()`
`User`	`getUser()`
`Integer`	`getUserId()`
`String`	`getVar()`
`Visit`	`getVisit()`
`Integer`	`getVisitId()`
`VisitType`	`getVisitType()`
`Integer`	`getVisitTypeId()`
`String`	`getWithConceptNameTag()`
`String`	`getWithConceptNameType()`
`protected void`	`printConcept(StringBuilder sb, Concept concept)` Formats a Concept and prints it to sb, respecting conceptNameType and conceptNameTag if they are specified and a match is found.
`void`	`setCaseConversion(String caseConversion)`
`void`	`setConcept(Concept concept)`
`void`	`setConceptId(Integer conceptId)`
`void`	`setEncounter(Encounter encounter)`
`void`	`setEncounterId(Integer encounterId)`
`void`	`setEncounterProviders(Map<EncounterRole,Set<Provider>> encounterProviders)`
`void`	`setEncounterType(EncounterType encounterType)`
`void`	`setEncounterTypeId(Integer encounterTypeId)`
`void`	`setForm(Form form)`
`void`	`setJavaScriptEscape(Boolean javaScriptEscape)`
`void`	`setLocation(Location location)`
`void`	`setLocationId(Integer locationId)`
`void`	`setLocationTag(LocationTag locationTag)`
`void`	`setLocationTagId(Integer locationTagId)`
`void`	`setObject(Object object)` Sets the object property
`void`	`setObsValue(Obs obsValue)`
`void`	`setPerson(Person person)`
`void`	`setPersonId(Integer personId)`
`void`	`setProgram(Program program)`
`void`	`setProgramId(Integer programId)`
`void`	`setSingleCustomValue(SingleCustomValue<?> singleCustomValue)`
`void`	`setUser(User user)`
`void`	`setUserId(Integer userId)`
`void`	`setVar(String var)`
`void`	`setVisit(Visit visit)`
`void`	`setVisitId(Integer visitId)`
`void`	`setVisitType(VisitType visitType)`
`void`	`setVisitTypeId(Integer visitTypeId)`
`void`	`setWithConceptNameTag(String withConceptNameTag)`
`void`	`setWithConceptNameType(String withConceptNameType)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

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

Constructor Detail
- FormatTag
```
public FormatTag()
```

Method Detail

doStartTag
```
public int doStartTag()
```
Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

printConcept
```
protected void printConcept(StringBuilder sb,
                            Concept concept)
```
Formats a Concept and prints it to sb, respecting conceptNameType and conceptNameTag if they are specified and a match is found. (This will always prints something.)

Parameters:

sb -

concept -

Expected Behavior:

Should print the name with the correct name and type

Should escape html tags

doEndTag
```
public int doEndTag()
```
Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

getObject
```
public Object getObject()
```
Gets the object property

Returns:

the object property value

setObject
```
public void setObject(Object object)
```
Sets the object property

Parameters:

object - the object to set

getConceptId
```
public Integer getConceptId()
```

setConceptId

public void setConceptId(Integer conceptId)

getConcept
```
public Concept getConcept()
```

setConcept

public void setConcept(Concept concept)

getObsValue
```
public Obs getObsValue()
```

setObsValue

public void setObsValue(Obs obsValue)

getUserId
```
public Integer getUserId()
```

setUserId

public void setUserId(Integer userId)

getUser
```
public User getUser()
```

setUser
```
public void setUser(User user)
```

getEncounterId
```
public Integer getEncounterId()
```

setEncounterId

public void setEncounterId(Integer encounterId)

getEncounter
```
public Encounter getEncounter()
```

setEncounter

public void setEncounter(Encounter encounter)

getEncounterTypeId
```
public Integer getEncounterTypeId()
```

setEncounterTypeId

public void setEncounterTypeId(Integer encounterTypeId)

getEncounterType

public EncounterType getEncounterType()

setEncounterType

public void setEncounterType(EncounterType encounterType)

getLocationId
```
public Integer getLocationId()
```

setLocationId

public void setLocationId(Integer locationId)

getLocation
```
public Location getLocation()
```

setLocation

public void setLocation(Location location)

getLocationTagId
```
public Integer getLocationTagId()
```

setLocationTagId

public void setLocationTagId(Integer locationTagId)

getLocationTag
```
public LocationTag getLocationTag()
```

setLocationTag

public void setLocationTag(LocationTag locationTag)

getProgramId
```
public Integer getProgramId()
```

setProgramId

public void setProgramId(Integer programId)

getProgram
```
public Program getProgram()
```

setProgram

public void setProgram(Program program)

getVar
```
public String getVar()
```

setVar
```
public void setVar(String var)
```

getPersonId
```
public Integer getPersonId()
```

setPersonId

public void setPersonId(Integer personId)

getPerson
```
public Person getPerson()
```

setPerson
```
public void setPerson(Person person)
```

getVisitTypeId
```
public Integer getVisitTypeId()
```
Returns:

the visitTypeId

setVisitTypeId
```
public void setVisitTypeId(Integer visitTypeId)
```
Parameters:

visitTypeId - the visitTypeId to set

getVisitType
```
public VisitType getVisitType()
```
Returns:

the visitType

setVisitType
```
public void setVisitType(VisitType visitType)
```
Parameters:

visitType - the visitType to set

getVisitId
```
public Integer getVisitId()
```
Returns:

the visitId

Since:

1.9

setVisitId
```
public void setVisitId(Integer visitId)
```
Parameters:

visitId - the visitId to set

Since:

1.9

getVisit
```
public Visit getVisit()
```
Returns:

the visit

Since:

1.9

setVisit
```
public void setVisit(Visit visit)
```
Parameters:

visit - the visit to set

Since:

1.9

getJavaScriptEscape
```
public Boolean getJavaScriptEscape()
```
Returns:

the javaScriptEscape

setJavaScriptEscape
```
public void setJavaScriptEscape(Boolean javaScriptEscape)
```
Parameters:

javaScriptEscape - the javaScriptEscape to set

getEncounterProviders

public Map<EncounterRole,Set<Provider>> getEncounterProviders()

Returns:: the encounterProviders
Since:: 1.9

setEncounterProviders
```
public void setEncounterProviders(Map<EncounterRole,Set<Provider>> encounterProviders)
```
Parameters:

encounterProviders - the encounterProviders to set

Since:

1.9

getWithConceptNameType
```
public String getWithConceptNameType()
```
Returns:

the withConceptNameType

Since:

1.9

setWithConceptNameType
```
public void setWithConceptNameType(String withConceptNameType)
```
Parameters:

withConceptNameType - the withConceptNameType to set

Since:

1.9

getWithConceptNameTag
```
public String getWithConceptNameTag()
```
Returns:

the withConceptNameTag

Since:

1.9

setWithConceptNameTag
```
public void setWithConceptNameTag(String withConceptNameTag)
```
Parameters:

withConceptNameTag - the withConceptNameTag to set

Since:

1.9

getForm
```
public Form getForm()
```
Returns:

the form

setForm
```
public void setForm(Form form)
```
Parameters:

form - the form to set

getSingleCustomValue

public SingleCustomValue<?> getSingleCustomValue()

Returns:: the singleCustomValue

setSingleCustomValue
```
public void setSingleCustomValue(SingleCustomValue<?> singleCustomValue)
```
Parameters:

singleCustomValue - the singleCustomValue to set

getCaseConversion
```
public String getCaseConversion()
```

setCaseConversion

public void setCaseConversion(String caseConversion)

Class FormatTag

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

Methods inherited from class java.lang.Object

Constructor Detail

FormatTag

Method Detail

doStartTag

printConcept

doEndTag

getObject

setObject

getConceptId

setConceptId

getConcept

setConcept

getObsValue

setObsValue

getUserId

setUserId

getUser

setUser

getEncounterId

setEncounterId

getEncounter

setEncounter

getEncounterTypeId

setEncounterTypeId

getEncounterType

setEncounterType

getLocationId

setLocationId

getLocation

setLocation

getLocationTagId

setLocationTagId

getLocationTag

setLocationTag

getProgramId

setProgramId

getProgram

setProgram

getVar

setVar

getPersonId

setPersonId

getPerson

setPerson

getVisitTypeId

setVisitTypeId

getVisitType

setVisitType

getVisitId

setVisitId

getVisit

setVisit

getJavaScriptEscape

setJavaScriptEscape

getEncounterProviders

setEncounterProviders

getWithConceptNameType

setWithConceptNameType

getWithConceptNameTag

setWithConceptNameTag

getForm

setForm

getSingleCustomValue

setSingleCustomValue

getCaseConversion

setCaseConversion