org.hackystat.projectbrowser.page.telemetry
Class TelemetrySession

java.lang.Object
  extended by org.hackystat.projectbrowser.page.telemetry.TelemetrySession
All Implemented Interfaces:
java.io.Serializable

public class TelemetrySession
extends java.lang.Object
implements java.io.Serializable

Session to hold state for telemetry.

Author:
Shaoxuan Zhang
See Also:
Serialized Form

Field Summary
static java.lang.String END_DATE_KEY
          The parameter key of end date.
static java.lang.String GRANULARITY_KEY
          The parameter key of granularity.
static java.lang.String PARAMETER_ORDER_MESSAGE
          The parameter instruction message.
static java.lang.String SELECTED_PROJECTS_KEY
          The parameter key of selectedProjects.
static java.lang.String START_DATE_KEY
          The parameter key of start date.
static java.lang.String TELEMETRY_KEY
          The parameter key of telemetry.
static java.lang.String TELEMETRY_PARAMERTERS_KEY
          The parameter key of telemetry parameters.
 
Constructor Summary
TelemetrySession()
          Create the instance.
 
Method Summary
 void cancelDataUpdate()
          Cancel data model's update.
 void clearParamErrorMessage()
          Clears the paramErrorMessage.
 java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartDefinition> getChartDescriptions()
           
 TelemetryChartDataModel getDataModel()
           
 java.util.Date getEndDate()
           
 java.lang.String getFeedback()
           
 java.lang.String getGranularity()
           
 java.util.List<java.lang.String> getGranularityList()
           
 org.apache.wicket.PageParameters getPageParameters()
          Returns a PageParameters instance that represents the content of the input form.
 java.lang.String getParamErrorMessage()
           
 java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.ParameterDefinition> getParameterList()
          Return the list of ParameterDefinition under telemetry type in this session.
 java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.ParameterDefinition> getParameterList(java.lang.String telemetryName)
          Return the list of ParameterDefinition under the given telemetry.
 java.util.List<org.apache.wicket.model.IModel> getParameters()
           
 java.lang.String getParametersAsString()
          Returns the list of the parameters in a single String, separated by comma.
 java.util.List<org.hackystat.sensorbase.resource.projects.jaxb.Project> getSelectedProjects()
           
 java.util.Date getStartDate()
           
 java.util.Map<java.lang.String,org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartDefinition> getTelemetryDefs()
           
 java.util.List<java.lang.String> getTelemetryList()
          Return the TelemetryList.
 java.lang.String getTelemetryName()
           
static boolean isValueMatchType(java.lang.String value, org.hackystat.telemetry.service.resource.chart.jaxb.Type type)
          Checks if the given value is of the given type.
 boolean loadPageParameters(org.apache.wicket.PageParameters parameters)
          Load data from URL parameters into this session.
 void setEndDate(java.util.Date endDate)
           
 void setFeedback(java.lang.String feedback)
           
 void setGranularity(java.lang.String granularity)
           
 void setSelectedProjects(java.util.List<org.hackystat.sensorbase.resource.projects.jaxb.Project> selectedProjects)
           
 void setStartDate(java.util.Date startDate)
           
 void setTelemetryName(java.lang.String telemetryName)
           
 void updateDataModel()
          Update the data model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TELEMETRY_KEY

public static final java.lang.String TELEMETRY_KEY
The parameter key of telemetry.

See Also:
Constant Field Values

GRANULARITY_KEY

public static final java.lang.String GRANULARITY_KEY
The parameter key of granularity.

See Also:
Constant Field Values

START_DATE_KEY

public static final java.lang.String START_DATE_KEY
The parameter key of start date.

See Also:
Constant Field Values

END_DATE_KEY

public static final java.lang.String END_DATE_KEY
The parameter key of end date.

See Also:
Constant Field Values

SELECTED_PROJECTS_KEY

public static final java.lang.String SELECTED_PROJECTS_KEY
The parameter key of selectedProjects.

See Also:
Constant Field Values

TELEMETRY_PARAMERTERS_KEY

public static final java.lang.String TELEMETRY_PARAMERTERS_KEY
The parameter key of telemetry parameters.

See Also:
Constant Field Values

PARAMETER_ORDER_MESSAGE

public static final java.lang.String PARAMETER_ORDER_MESSAGE
The parameter instruction message.

See Also:
Constant Field Values
Constructor Detail

TelemetrySession

public TelemetrySession()
Create the instance.

Method Detail

getParameters

public java.util.List<org.apache.wicket.model.IModel> getParameters()
Returns:
the parameters

getParametersAsString

public java.lang.String getParametersAsString()
Returns the list of the parameters in a single String, separated by comma.

Returns:
a String.

setFeedback

public void setFeedback(java.lang.String feedback)
Parameters:
feedback - the feedback to set

getFeedback

public java.lang.String getFeedback()
Returns:
the feedback

setTelemetryName

public void setTelemetryName(java.lang.String telemetryName)
Parameters:
telemetryName - the telemetry to set

getTelemetryName

public java.lang.String getTelemetryName()
Returns:
the telemetry

getTelemetryList

public java.util.List<java.lang.String> getTelemetryList()
Return the TelemetryList. Initialize it if it is null.

Returns:
the telemetryList

getParameterList

public java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.ParameterDefinition> getParameterList()
Return the list of ParameterDefinition under telemetry type in this session.

Returns:
list of ParameterDefinition.

getParameterList

public java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.ParameterDefinition> getParameterList(java.lang.String telemetryName)
Return the list of ParameterDefinition under the given telemetry.

Parameters:
telemetryName - the telemetry
Returns:
list of ParameterDefinition.

setStartDate

public void setStartDate(java.util.Date startDate)
Parameters:
startDate - the startDate to set

getStartDate

public java.util.Date getStartDate()
Returns:
the startDate

setEndDate

public void setEndDate(java.util.Date endDate)
Parameters:
endDate - the endDate to set

getEndDate

public java.util.Date getEndDate()
Returns:
the endDate

setGranularity

public void setGranularity(java.lang.String granularity)
Parameters:
granularity - the granularity to set

getGranularity

public java.lang.String getGranularity()
Returns:
the granularity

getGranularityList

public java.util.List<java.lang.String> getGranularityList()
Returns:
the granularityList

updateDataModel

public void updateDataModel()
Update the data model. If execute in background process is determined in ProjectBrowserProperties.


cancelDataUpdate

public void cancelDataUpdate()
Cancel data model's update.


getDataModel

public TelemetryChartDataModel getDataModel()
Returns:
the dataModel

setSelectedProjects

public void setSelectedProjects(java.util.List<org.hackystat.sensorbase.resource.projects.jaxb.Project> selectedProjects)
Parameters:
selectedProjects - the selectedProjects to set

getSelectedProjects

public java.util.List<org.hackystat.sensorbase.resource.projects.jaxb.Project> getSelectedProjects()
Returns:
the selectedProjects

getTelemetryDefs

public java.util.Map<java.lang.String,org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartDefinition> getTelemetryDefs()
Returns:
the telemetrys

getChartDescriptions

public java.util.List<org.hackystat.telemetry.service.resource.chart.jaxb.TelemetryChartDefinition> getChartDescriptions()
Returns:
the list of TelemetryChartDefinition.

loadPageParameters

public boolean loadPageParameters(org.apache.wicket.PageParameters parameters)
Load data from URL parameters into this session.

Parameters:
parameters - the URL parameters
Returns:
true if all parameters are loaded correctly

isValueMatchType

public static boolean isValueMatchType(java.lang.String value,
                                       org.hackystat.telemetry.service.resource.chart.jaxb.Type type)
Checks if the given value is of the given type.

Parameters:
value - the given value.
type - the given type.
Returns:
true if the value and type are matched.

getPageParameters

public org.apache.wicket.PageParameters getPageParameters()
Returns a PageParameters instance that represents the content of the input form.

Returns:
a PageParameters instance.

getParamErrorMessage

public java.lang.String getParamErrorMessage()
Returns:
the paramErrorMessage

clearParamErrorMessage

public void clearParamErrorMessage()
Clears the paramErrorMessage.