org.eobjects.datacleaner.monitor.shared.model
Class MetricIdentifier

java.lang.Object
  org.eobjects.datacleaner.monitor.shared.model.MetricIdentifier

All Implemented Interfaces:

Serializable, Comparable<MetricIdentifier>

public class MetricIdentifier
extends Object
implements Serializable, Comparable<MetricIdentifier>

Identifies a metric of interest.

See Also:

Serialized Form

Constructor Summary

MetricIdentifier()

MetricIdentifier(String metricDisplayName, String formula, List<MetricIdentifier> children)

MetricIdentifier(String metricDisplayName, String analyzerDescriptorName, String analyzerName, String analyzerInputName, String metricDescriptorName, String paramQueryString, String paramColumnName, boolean parameterizedByQueryString, boolean parameterizedByColumnName)

Method Summary

int	compareTo(MetricIdentifier other)
MetricIdentifier	copy() Creates a copy of this MetricIdentifier.
boolean	equals(Object obj)
boolean	equalsIgnoreCustomizedDetails(MetricIdentifier other) Determines if two MetricIdentifiers match if ignoring the details that can be customized/parameterized by the user: Display name Color
boolean	equalsIgnoreParameterValues(MetricIdentifier other) Determines if two MetricIdentifiers match if ignoring parameter values as well as the details that can be customized/parameterized by the user: Display name Color Query parameter Column parameter In other words - determines if the two MetricIdentifiers reference the same metric in the same AnalyzerResult.
String	getAnalyzerDescriptorName()
String	getAnalyzerInputName()
String	getAnalyzerName()
List<MetricIdentifier>	getChildren()
String	getDisplayName()
String	getFormula()
String	getId()
String	getMetricColor()
String	getMetricDescriptorName()
String	getParamColumnName()
String	getParamQueryString()
int	hashCode()
boolean	isDisplayNameSet() Determines if the displayname has been set by the user or if it is automatically generated based on the metric's descriptor.
boolean	isFormulaBased()
boolean	isParameterizedByColumnName()
boolean	isParameterizedByQueryString()
void	setAnalyzerDescriptorName(String analyzerDescriptorName)
void	setAnalyzerInputName(String analyzerInputName)
void	setAnalyzerName(String analyzerName)
void	setChildren(List<MetricIdentifier> children)
void	setFormula(String formula)
void	setMetricColor(String metricColor)
void	setMetricDescriptorName(String metricDescriptorName)
void	setMetricDisplayName(String metricDisplayName)
void	setParamColumnName(String paramColumnName)
void	setParameterizedByColumnName(boolean parameterizedByColumnName)
void	setParameterizedByQueryString(boolean parameterizedByQueryString)
void	setParamQueryString(String paramQueryString)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricIdentifier

public MetricIdentifier(String metricDisplayName,
                        String analyzerDescriptorName,
                        String analyzerName,
                        String analyzerInputName,
                        String metricDescriptorName,
                        String paramQueryString,
                        String paramColumnName,
                        boolean parameterizedByQueryString,
                        boolean parameterizedByColumnName)

MetricIdentifier

public MetricIdentifier(String metricDisplayName,
                        String formula,
                        List<MetricIdentifier> children)

MetricIdentifier

public MetricIdentifier()

Method Detail

isFormulaBased

public boolean isFormulaBased()

getId

public String getId()

getAnalyzerDescriptorName

public String getAnalyzerDescriptorName()

setAnalyzerDescriptorName

public void setAnalyzerDescriptorName(String analyzerDescriptorName)

getAnalyzerName

public String getAnalyzerName()

setAnalyzerName

public void setAnalyzerName(String analyzerName)

getMetricDescriptorName

public String getMetricDescriptorName()

setMetricDescriptorName

public void setMetricDescriptorName(String metricDescriptorName)

getAnalyzerInputName

public String getAnalyzerInputName()

setAnalyzerInputName

public void setAnalyzerInputName(String analyzerInputName)

setParamColumnName

public void setParamColumnName(String paramColumnName)

getParamColumnName

public String getParamColumnName()

setParamQueryString

public void setParamQueryString(String paramQueryString)

getParamQueryString

public String getParamQueryString()

isParameterizedByColumnName

public boolean isParameterizedByColumnName()

setParameterizedByColumnName

public void setParameterizedByColumnName(boolean parameterizedByColumnName)

isParameterizedByQueryString

public boolean isParameterizedByQueryString()

setParameterizedByQueryString

public void setParameterizedByQueryString(boolean parameterizedByQueryString)

setMetricDisplayName

public void setMetricDisplayName(String metricDisplayName)

getDisplayName

public String getDisplayName()

isDisplayNameSet

public boolean isDisplayNameSet()

Determines if the displayname has been set by the user or if it is automatically generated based on the metric's descriptor.

Returns:

setMetricColor

public void setMetricColor(String metricColor)

getMetricColor

public String getMetricColor()

copy

public MetricIdentifier copy()

Creates a copy of this MetricIdentifier.

Returns:

setFormula

public void setFormula(String formula)

getFormula

public String getFormula()

setChildren

public void setChildren(List<MetricIdentifier> children)

getChildren

public List<MetricIdentifier> getChildren()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsIgnoreParameterValues

public boolean equalsIgnoreParameterValues(MetricIdentifier other)

Determines if two MetricIdentifiers match if ignoring parameter values as well as the details that can be customized/parameterized by the user:

• Display name
• Color
• Query parameter
• Column parameter

In other words - determines if the two MetricIdentifiers reference the same metric in the same AnalyzerResult.

Parameters:

other -

Returns:

equalsIgnoreCustomizedDetails

public boolean equalsIgnoreCustomizedDetails(MetricIdentifier other)

Determines if two MetricIdentifiers match if ignoring the details that can be customized/parameterized by the user:

• Display name
• Color

Parameters:

other -

Returns:

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(MetricIdentifier other)

Specified by:

compareTo in interface Comparable<MetricIdentifier>