Package org.dashbuilder.displayer

Class DisplayerConstraints

java.lang.Object

org.dashbuilder.displayer.DisplayerConstraints

public class DisplayerConstraints
extends Object

Every Displayer implementation use this class to specify what are the supported DisplayerSettings attributes as well as the supported data sets in order to fit the displayer needs.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.dashbuilder.dataset.DataSetLookupConstraints	dataSetLookupConstraints
static int	ERROR_DATASET_LOOKUP_CONSTRAINTS_NOT_FOUND
protected Set<DisplayerAttributeDef>	excludedEditorAttributes
protected Set<DisplayerAttributeDef>	supportedEditorAttributes
protected Set<String>	supportedEditorAttrStrings
protected boolean	supportingComponentAttributes

Constructor Summary

Constructors

Constructor	Description
DisplayerConstraints(org.dashbuilder.dataset.DataSetLookupConstraints dataSetLookupConstraints)

Method Summary

Modifier and Type	Method	Description
org.dashbuilder.dataset.ValidationError	check(DisplayerSettings settings)
protected org.dashbuilder.dataset.ValidationError	createValidationError(int error)
DisplayerConstraints	excludeAttribute(DisplayerAttributeDef attributeDef)
org.dashbuilder.dataset.DataSetLookupConstraints	getDataSetLookupConstraints()
Set<DisplayerAttributeDef>	getSupportedAttributes()
void	removeUnsupportedAttributes(DisplayerSettings displayerSettings)
DisplayerConstraints	setDataSetLookupConstraints(org.dashbuilder.dataset.DataSetLookupConstraints dataSetLookupConstraints)
DisplayerConstraints	supportingComponentAttributes(boolean supportingComponentAttributes)
DisplayerConstraints	supportsAttribute(DisplayerAttributeDef attributeDef)

Methods inherited from class java.lang.Object

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

Field Detail

dataSetLookupConstraints

protected org.dashbuilder.dataset.DataSetLookupConstraints dataSetLookupConstraints

supportedEditorAttributes

protected Set<DisplayerAttributeDef> supportedEditorAttributes

excludedEditorAttributes

protected Set<DisplayerAttributeDef> excludedEditorAttributes

supportedEditorAttrStrings

protected Set<String> supportedEditorAttrStrings

supportingComponentAttributes

protected boolean supportingComponentAttributes

ERROR_DATASET_LOOKUP_CONSTRAINTS_NOT_FOUND

public static final int ERROR_DATASET_LOOKUP_CONSTRAINTS_NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

DisplayerConstraints

public DisplayerConstraints(org.dashbuilder.dataset.DataSetLookupConstraints dataSetLookupConstraints)

Method Detail

supportingComponentAttributes

public DisplayerConstraints supportingComponentAttributes(boolean supportingComponentAttributes)

supportsAttribute

public DisplayerConstraints supportsAttribute(DisplayerAttributeDef attributeDef)

excludeAttribute

public DisplayerConstraints excludeAttribute(DisplayerAttributeDef attributeDef)

getSupportedAttributes

public Set<DisplayerAttributeDef> getSupportedAttributes()

getDataSetLookupConstraints

public org.dashbuilder.dataset.DataSetLookupConstraints getDataSetLookupConstraints()

setDataSetLookupConstraints

public DisplayerConstraints setDataSetLookupConstraints(org.dashbuilder.dataset.DataSetLookupConstraints dataSetLookupConstraints)

removeUnsupportedAttributes

public void removeUnsupportedAttributes(DisplayerSettings displayerSettings)

check

public org.dashbuilder.dataset.ValidationError check(DisplayerSettings settings)

createValidationError

protected org.dashbuilder.dataset.ValidationError createValidationError(int error)