org.openmrs.layout.web

Class LayoutTemplate

java.lang.Object

org.openmrs.layout.web.LayoutTemplate

Direct Known Subclasses:

AddressTemplate, NameTemplate

public abstract class LayoutTemplate
extends java.lang.Object

Generic class used by AddressTemplate and NameTemplate layouts

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	codeName
protected java.lang.String	country
protected java.lang.String	displayName
protected java.util.Map<java.lang.String,java.lang.String>	elementDefaults
protected java.util.Map<java.lang.String,java.lang.String>	elementRegex
protected java.util.Map<java.lang.String,java.lang.String>	elementRegexFormats
protected java.lang.String	endDate
protected java.lang.String	LAYOUT_TOKEN
protected java.util.List<java.lang.String>	lineByLineFormat
protected int	maxTokens
protected java.util.Map<java.lang.String,java.lang.String>	nameMappings
protected java.util.Map<java.lang.String,java.lang.String>	sizeMappings
protected java.lang.String	startDate

Constructor Summary

Constructors

Constructor and Description
LayoutTemplate()
LayoutTemplate(java.lang.String simpleTemplate) Very crude way of setting just one line of template.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCodeName()
java.lang.String	getCountry()
java.lang.String	getDisplayName()
java.util.Map<java.lang.String,java.lang.String>	getElementDefaults()
java.util.Map<java.lang.String,java.lang.String>	getElementRegex() Get the element regular expressions.
java.util.Map<java.lang.String,java.lang.String>	getElementRegexFormats() Get the element formats.
abstract LayoutSupport<?>	getLayoutSupportInstance()
abstract java.lang.String	getLayoutToken()
java.util.List<java.lang.String>	getLineByLineFormat()
java.util.List<java.util.List<java.util.Map<java.lang.String,java.lang.String>>>	getLines()
int	getMaxTokens()
java.util.Map<java.lang.String,java.lang.String>	getNameMappings()
abstract java.lang.String	getNonLayoutToken()
java.util.Map<java.lang.String,java.lang.String>	getSizeMappings()
java.util.List<java.lang.String>	nonUniqueStringsGoLast(java.util.List<java.lang.String> strListArg)
void	setCodeName(java.lang.String codeName)
void	setCountry(java.lang.String country)
void	setDisplayName(java.lang.String displayName)
void	setElementDefaults(java.util.Map<java.lang.String,java.lang.String> elementDefaults)
void	setElementRegex(java.util.Map<java.lang.String,java.lang.String> elementRegex) Set the element regular expressions.
void	setElementRegexFormats(java.util.Map<java.lang.String,java.lang.String> elementRegexFormats) Set the element formats.
void	setLineByLineFormat(java.util.List<java.lang.String> lineByLineFormat)
void	setMaxTokens(int maxTokens)
void	setNameMappings(java.util.Map<java.lang.String,java.lang.String> nameMappings)
void	setSizeMappings(java.util.Map<java.lang.String,java.lang.String> sizeMappings)

Methods inherited from class java.lang.Object

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

Field Detail

LAYOUT_TOKEN

protected final java.lang.String LAYOUT_TOKEN

See Also:

Constant Field Values

displayName

protected java.lang.String displayName

codeName

protected java.lang.String codeName

country

protected java.lang.String country

nameMappings

protected java.util.Map<java.lang.String,java.lang.String> nameMappings

sizeMappings

protected java.util.Map<java.lang.String,java.lang.String> sizeMappings

elementDefaults

protected java.util.Map<java.lang.String,java.lang.String> elementDefaults

elementRegex

protected java.util.Map<java.lang.String,java.lang.String> elementRegex

elementRegexFormats

protected java.util.Map<java.lang.String,java.lang.String> elementRegexFormats

lineByLineFormat

protected java.util.List<java.lang.String> lineByLineFormat

maxTokens

protected int maxTokens

startDate

protected java.lang.String startDate

endDate

protected java.lang.String endDate

Constructor Detail

LayoutTemplate

public LayoutTemplate()

LayoutTemplate

public LayoutTemplate(java.lang.String simpleTemplate)

Very crude way of setting just one line of template. This just puts something on setLineByLineFormat(List) with this string

Parameters:

simpleTemplate - first template line

Method Detail

getLayoutToken

public abstract java.lang.String getLayoutToken()

getNonLayoutToken

public abstract java.lang.String getNonLayoutToken()

getLines

public java.util.List<java.util.List<java.util.Map<java.lang.String,java.lang.String>>> getLines()

getCodeName

public java.lang.String getCodeName()

Returns:

the codeName

setCodeName

public void setCodeName(java.lang.String codeName)

Parameters:

codeName - the codeName to set

getCountry

public java.lang.String getCountry()

Returns:

the country

setCountry

public void setCountry(java.lang.String country)

Parameters:

country - the country to set

getDisplayName

public java.lang.String getDisplayName()

Returns:

the displayName

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the displayName to set

getElementDefaults

public java.util.Map<java.lang.String,java.lang.String> getElementDefaults()

Returns:

the elementDefaults

setElementDefaults

public void setElementDefaults(java.util.Map<java.lang.String,java.lang.String> elementDefaults)

Parameters:

elementDefaults - the elementDefaults to set

getElementRegex

public java.util.Map<java.lang.String,java.lang.String> getElementRegex()

Get the element regular expressions. These can be used to enforce that an element matches a regex.

Returns:

the elementRegex

setElementRegex

public void setElementRegex(java.util.Map<java.lang.String,java.lang.String> elementRegex)

Set the element regular expressions. These can be used to enforce that an element matches a regex.

Parameters:

elementRegex - the elementRegex to set

getElementRegexFormats

public java.util.Map<java.lang.String,java.lang.String> getElementRegexFormats()

Get the element formats. These can be used to display an example format that an element should look like.

Returns:

the elementFormats

setElementRegexFormats

public void setElementRegexFormats(java.util.Map<java.lang.String,java.lang.String> elementRegexFormats)

Set the element formats. These can be used to display an example format that an element should look like.

Parameters:

elementFormats - the elementFormats to set

getLineByLineFormat

public java.util.List<java.lang.String> getLineByLineFormat()

Returns:

the lineByLineFormat

setLineByLineFormat

public void setLineByLineFormat(java.util.List<java.lang.String> lineByLineFormat)

Parameters:

lineByLineFormat - the lineByLineFormat to set

getMaxTokens

public int getMaxTokens()

Returns:

the maxTokens

setMaxTokens

public void setMaxTokens(int maxTokens)

Parameters:

maxTokens - the maxTokens to set

getNameMappings

public java.util.Map<java.lang.String,java.lang.String> getNameMappings()

Returns:

the nameMappings

setNameMappings

public void setNameMappings(java.util.Map<java.lang.String,java.lang.String> nameMappings)

Parameters:

nameMappings - the nameMappings to set

getSizeMappings

public java.util.Map<java.lang.String,java.lang.String> getSizeMappings()

Returns:

the sizeMappings

setSizeMappings

public void setSizeMappings(java.util.Map<java.lang.String,java.lang.String> sizeMappings)

Parameters:

sizeMappings - the sizeMappings to set

getLayoutSupportInstance

public abstract LayoutSupport<?> getLayoutSupportInstance()

nonUniqueStringsGoLast

public java.util.List<java.lang.String> nonUniqueStringsGoLast(java.util.List<java.lang.String> strListArg)