com.endeca.portal.attributes.viewmodel
Class PredefinedMetric

java.lang.Object
  extended by com.endeca.portal.attributes.model.BasePropertyContainer
      extended by com.endeca.portal.attributes.viewmodel.PredefinedMetric

public class PredefinedMetric
extends BasePropertyContainer

Represents an metric object serializable via Jackson

Author:
Endeca Technologies, Inc

Field Summary
static java.lang.String DATA_TYPE_PROPERTY
           
static java.lang.String DEFINITION_PROPERTY
           
static java.lang.String DESCRIPTION_PROPERTY
           
static java.lang.String DISPLAY_NAME_PROPERTY
           
static java.lang.String EXPRESSION_AST
           
static java.lang.String FORMATTER_PROPERTY
           
static java.lang.String IS_SINGLE_ASSIGN_PROPERTY
           
static java.lang.String LOCALIZED_DESCRIPTION_PROPERTY
           
static java.lang.String LOCALIZED_DISPLAY_NAME_PROPERTY
           
static java.lang.String STANDARD_FORMAT_PROPERTY
           
 
Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
KEY_PROPERTY, properties
 
Constructor Summary
PredefinedMetric()
           
 
Method Summary
 java.lang.String getDataType()
           
 java.lang.String getDefinition()
           
 java.lang.String getDescription()
           
 java.lang.String getDisplayName()
           
 java.lang.String getDisplayName(java.util.Locale locale)
          Get display name by locale settings
 java.lang.String getDisplayName(javax.portlet.PortletRequest request)
          Get display name by request
 java.lang.String getDisplayName(java.lang.String languageId)
          Get display name bu language id
 com.endeca.mdex.eql_parser.types.ExpressionBase getExpressionAST()
           
 java.lang.String getFormatter()
           
 java.lang.String getLocalizedDescription()
           
 java.lang.String getLocalizedDisplayName()
           
 java.lang.String getStandardFormat()
           
 boolean isSingleAssign()
           
 void setDataType(java.lang.String dataType)
          Sets the dataType
 void setDefinition(java.lang.String definition)
          Sets the definition
 void setDescription(java.lang.String description)
          Sets the description
 void setDisplayName(java.lang.String displayName)
           
 void setExpressionAST(com.endeca.mdex.eql_parser.types.ExpressionBase exprAST)
           
 void setFormatter(java.lang.String formatter)
          Sets the Formatter
 void setLocalizedDescription(java.lang.String description)
           
 void setLocalizedDisplayName(java.lang.String displayName)
           
 void setSingleAssign(boolean isSingleAssign)
          Sets whether or not this is Single Assign
 void setStandardFormat(java.lang.String standardFormat)
          Sets the StandardFormat
 
Methods inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
addProperty, getKey, getProperties, getProperty, getProperty, isEmpty, isValid, setKey, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DISPLAY_NAME_PROPERTY

public static final java.lang.String DISPLAY_NAME_PROPERTY
See Also:
Constant Field Values

LOCALIZED_DISPLAY_NAME_PROPERTY

public static final java.lang.String LOCALIZED_DISPLAY_NAME_PROPERTY
See Also:
Constant Field Values

LOCALIZED_DESCRIPTION_PROPERTY

public static final java.lang.String LOCALIZED_DESCRIPTION_PROPERTY
See Also:
Constant Field Values

DATA_TYPE_PROPERTY

public static final java.lang.String DATA_TYPE_PROPERTY
See Also:
Constant Field Values

DEFINITION_PROPERTY

public static final java.lang.String DEFINITION_PROPERTY
See Also:
Constant Field Values

DESCRIPTION_PROPERTY

public static final java.lang.String DESCRIPTION_PROPERTY
See Also:
Constant Field Values

IS_SINGLE_ASSIGN_PROPERTY

public static final java.lang.String IS_SINGLE_ASSIGN_PROPERTY
See Also:
Constant Field Values

FORMATTER_PROPERTY

public static final java.lang.String FORMATTER_PROPERTY
See Also:
Constant Field Values

STANDARD_FORMAT_PROPERTY

public static final java.lang.String STANDARD_FORMAT_PROPERTY
See Also:
Constant Field Values

EXPRESSION_AST

public static final java.lang.String EXPRESSION_AST
See Also:
Constant Field Values
Constructor Detail

PredefinedMetric

public PredefinedMetric()
Method Detail

setDisplayName

public void setDisplayName(java.lang.String displayName)
Parameters:
displayName - the displayName to set

getDisplayName

public java.lang.String getDisplayName()
Returns:
the displayName

getDisplayName

public java.lang.String getDisplayName(java.lang.String languageId)
Get display name bu language id

Parameters:
languageId -
Returns:

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale)
Get display name by locale settings

Parameters:
locale -
Returns:

getDisplayName

public java.lang.String getDisplayName(javax.portlet.PortletRequest request)
Get display name by request

Parameters:
locale -
Returns:

setLocalizedDisplayName

public void setLocalizedDisplayName(java.lang.String displayName)
Parameters:
LocalizedDisplayName - the LocalizedDisplayName to set

getLocalizedDisplayName

public java.lang.String getLocalizedDisplayName()
Returns:
the LocalizedDisplayName

getLocalizedDescription

public java.lang.String getLocalizedDescription()
Returns:
the LocalizedDescription

setLocalizedDescription

public void setLocalizedDescription(java.lang.String description)
Parameters:
LocalizedDescription - the LocalizedDescription to set

setDataType

public void setDataType(java.lang.String dataType)
Sets the dataType

Parameters:
dataType - the dataType to set

getDataType

public java.lang.String getDataType()
Returns:
the dataType

setDefinition

public void setDefinition(java.lang.String definition)
Sets the definition

Parameters:
definition - the definition to set

getDefinition

public java.lang.String getDefinition()
Returns:
the definition

setExpressionAST

public void setExpressionAST(com.endeca.mdex.eql_parser.types.ExpressionBase exprAST)

getExpressionAST

public com.endeca.mdex.eql_parser.types.ExpressionBase getExpressionAST()

setDescription

public void setDescription(java.lang.String description)
Sets the description

Parameters:
description - the description to set

getDescription

public java.lang.String getDescription()
Returns:
the description

setFormatter

public void setFormatter(java.lang.String formatter)
Sets the Formatter

Parameters:
formatter - the Formatter to set

getFormatter

public java.lang.String getFormatter()
Returns:
the Formatter

setStandardFormat

public void setStandardFormat(java.lang.String standardFormat)
Sets the StandardFormat

Parameters:
standardFormat - the StandardFormat to set

getStandardFormat

public java.lang.String getStandardFormat()
Returns:
the StandardFormat

isSingleAssign

public boolean isSingleAssign()
Returns:
true if this is Single Assign(not multi-value)

setSingleAssign

public void setSingleAssign(boolean isSingleAssign)
Sets whether or not this is Single Assign

Parameters:
isRefineable -