org.tolven.app.entity
Class MSColumn

java.lang.Object
  org.tolven.app.entity.MSColumn

All Implemented Interfaces:

java.io.Serializable, AppLocaleText

public class MSColumn
extends java.lang.Object
implements java.io.Serializable, AppLocaleText

See Also:

Serialized Form

Constructor Summary

MSColumn()

MSColumn(AccountMenuStructure menuStructure, int sequence, java.lang.String heading, java.lang.String internal, java.lang.String displayFunction)

MSColumn(AccountMenuStructure menuStructure, int sequence, java.lang.String heading, java.lang.String internal, java.lang.String displayFunction, java.lang.String displayFunctionArguments)

Method Summary

boolean	equals(java.lang.Object obj) Compare two MenuData objects for equality.
Account	getAccount()
java.lang.String	getAlign()
AppLocaleMap	getDefaultLocaleText() This method exists to handle the fact that JSF's method binding is limited to Map property type behavior.
java.lang.String	getDefaultLocaleText(java.util.ResourceBundle bundle)
java.lang.String	getDisplayFunction() Either contains the name of a MenuData field (eg string01) or if DisplayFunctionArguments is non-null, a Java "format" specification.
java.lang.String	getDisplayFunctionArguments() A comma-separated list, no spaces, with the names of MD fields (eg string01) used as arguments to displayFunction format.
static java.lang.String	getDisplayFunctionColumn(MSColumn col, MenuData md)
java.lang.String	getFormattedColumn(MenuData md, java.util.Date now, java.util.TimeZone timeZone, java.util.Locale locale) Return the data specified by this column as a string.
java.lang.String	getFrom() The from string contains one or more EL strings that can fetch data from the underlying document.
java.lang.String	getHeading()
long	getId()
java.lang.String	getInternal()
AppLocaleMap	getLocaleText() This method exists to handle the fact that JSF's method binding is limited to Map property type behavior.
java.lang.String	getLocaleText(java.util.ResourceBundle bundle)
java.lang.String	getLocaleTextKey() Return a key for entries in MessagesBundles
MenuStructure	getMenuStructure()
int	getSequence()
java.lang.String	getSupressColumns() A comma-separated list of the columns to supress duplicates if sorting on this column.
java.lang.String	getVisible()
java.lang.Float	getWidth() Get the width of this column in EMs (relative to fund size).
int	hashCode() Return a hash code for this object.
void	setAccount(Account account)
void	setAlign(java.lang.String align)
void	setDisplayFunction(java.lang.String displayFunction)
void	setDisplayFunctionArguments(java.lang.String displayFunctionArguments)
void	setFrom(java.lang.String fromDocument)
void	setHeading(java.lang.String heading)
void	setId(long id)
void	setInternal(java.lang.String internal)
void	setMenuStructure(MenuStructure menuStructure)
void	setSequence(int sequence)
void	setSupressColumns(java.lang.String supressColumns)
void	setVisible(java.lang.String visible)
void	setWidth(java.lang.Float width)
java.lang.String	toString() Privide a debug string representation for this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MSColumn

public MSColumn()

MSColumn

public MSColumn(AccountMenuStructure menuStructure,
                int sequence,
                java.lang.String heading,
                java.lang.String internal,
                java.lang.String displayFunction)

MSColumn

public MSColumn(AccountMenuStructure menuStructure,
                int sequence,
                java.lang.String heading,
                java.lang.String internal,
                java.lang.String displayFunction,
                java.lang.String displayFunctionArguments)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compare two MenuData objects for equality. This test is based on the surrogate ID, not the data contents.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Privide a debug string representation for this object. (non-Javadoc)

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

hashCode

public int hashCode()

Return a hash code for this object. Note: The hashCode is based on the id and therefore cannot be determined until the ide is created which will be after a call to em.persist().

Overrides:

hashCode in class java.lang.Object

Throws:

java.lang.IllegalStateException - if the id has not been established

getAccount

public Account getAccount()

setAccount

public void setAccount(Account account)

getHeading

public java.lang.String getHeading()

setHeading

public void setHeading(java.lang.String heading)

getId

public long getId()

setId

public void setId(long id)

getInternal

public java.lang.String getInternal()

setInternal

public void setInternal(java.lang.String internal)

getMenuStructure

public MenuStructure getMenuStructure()

getLocaleText

public java.lang.String getLocaleText(java.util.ResourceBundle bundle)

Specified by:

getLocaleText in interface AppLocaleText

getDefaultLocaleText

public java.lang.String getDefaultLocaleText(java.util.ResourceBundle bundle)

Specified by:

getDefaultLocaleText in interface AppLocaleText

getLocaleTextKey

public java.lang.String getLocaleTextKey()

Return a key for entries in MessagesBundles

Specified by:

getLocaleTextKey in interface AppLocaleText

Parameters:

locale -

Returns:

getLocaleText

public AppLocaleMap getLocaleText()

This method exists to handle the fact that JSF's method binding is limited to Map property type behavior. In JSF pages, this will be accessed as item.localeText[aResourceBundle] and returns the textOverride of the item, if defined, or the value found in the resource bundle

Specified by:

getLocaleText in interface AppLocaleText

Returns:

getDefaultLocaleText

public AppLocaleMap getDefaultLocaleText()

This method exists to handle the fact that JSF's method binding is limited to Map property type behavior. In JSF pages, this will be accessed as item.localeText[aResourceBundle] and ignores the textOverride of the item, in order to return the value found in the resource bundle

Specified by:

getDefaultLocaleText in interface AppLocaleText

Returns:

setMenuStructure

public void setMenuStructure(MenuStructure menuStructure)

getSequence

public int getSequence()

setSequence

public void setSequence(int sequence)

getDisplayFunction

public java.lang.String getDisplayFunction()

Either contains the name of a MenuData field (eg string01) or if DisplayFunctionArguments is non-null, a Java "format" specification. For example, this field might contain

%s, %s

and displayFunctionArguments might contain:

string01,string02

assuming that a person's last and first names are in string01 and string02 respectively.

Returns:

setDisplayFunction

public void setDisplayFunction(java.lang.String displayFunction)

getDisplayFunctionArguments

public java.lang.String getDisplayFunctionArguments()

A comma-separated list, no spaces, with the names of MD fields (eg string01) used as arguments to displayFunction format.

Returns:

setDisplayFunctionArguments

public void setDisplayFunctionArguments(java.lang.String displayFunctionArguments)

getSupressColumns

public java.lang.String getSupressColumns()

A comma-separated list of the columns to supress duplicates if sorting on this column. For example, sorting on the Name column might supress Name, Age, DOB, and Sex. Use the column number. For example:

1,2,3,4

Returns:

setSupressColumns

public void setSupressColumns(java.lang.String supressColumns)

getAlign

public java.lang.String getAlign()

setAlign

public void setAlign(java.lang.String align)

getWidth

public java.lang.Float getWidth()

Get the width of this column in EMs (relative to fund size). If not specified, a default will be used. The default will probably not be reasonable.

Returns:

setWidth

public void setWidth(java.lang.Float width)

getVisible

public java.lang.String getVisible()

setVisible

public void setVisible(java.lang.String visible)

getDisplayFunctionColumn

public static java.lang.String getDisplayFunctionColumn(MSColumn col,
                                                        MenuData md)

getFormattedColumn

public java.lang.String getFormattedColumn(MenuData md,
                                           java.util.Date now,
                                           java.util.TimeZone timeZone,
                                           java.util.Locale locale)

Return the data specified by this column as a string.

Parameters:

md -

now -

TimeZone -

locale -

Returns:

getFrom

public java.lang.String getFrom()

The from string contains one or more EL strings that can fetch data from the underlying document. A single vertical bar is used to separate the different from string. The first one that yields a non-null result is used.

Returns:

setFrom

public void setFrom(java.lang.String fromDocument)