org.eclipse.eavp.viz.service.styles

Class AbstractSeriesStyle

java.lang.Object

org.eclipse.eavp.viz.service.styles.AbstractSeriesStyle

All Implemented Interfaces:

ISeriesStyle

Direct Known Subclasses:

BasicErrorStyle, FakeSeriesStyle, XYZAxisStyle, XYZPlotStyle, XYZSeriesStyle

public abstract class AbstractSeriesStyle
extends java.lang.Object
implements ISeriesStyle

An abstract implementation of a series style object to be subclassed. It provides the basic architecture for mapping the properties of the style. It is recommended to use this class with a modified constructor to set the standard property key set to be used for different default cases. The methods declared in the ISeriesStyle that are implemented here are not meant to be overridden. From this, other classes do not have the rights to change the keys for the properties declared. All of the properties that should be available are to be set in the properties map in some constructor of the style. For the user's benefit, it is recommended to use public static final string variables to declare the keys for your properties.

Author:

Kasper Gammeltoft

Constructor Summary

Constructors

Constructor and Description
AbstractSeriesStyle() The constructor.

Method Summary

Modifier and Type	Method and Description
void	copy(AbstractSeriesStyle other) Copies the properties from the specified style to this style
boolean	equals(java.lang.Object other)
java.util.Set<java.lang.String>	getAllPropertyTypes() Gets a list of all of the different object properties available.
java.lang.Object	getProperty(java.lang.String propertyType) Gets the property value for the specified property type.
int	hashCode()
boolean	setProperty(java.lang.String propertyType, java.lang.Object value) Sets the property value for the specified property name.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSeriesStyle

public AbstractSeriesStyle()

The constructor. Initializes the properties map.

Method Detail

copy

public void copy(AbstractSeriesStyle other)

Copies the properties from the specified style to this style

Parameters:

other - The other style to copy

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAllPropertyTypes

public java.util.Set<java.lang.String> getAllPropertyTypes()

Description copied from interface: ISeriesStyle

Gets a list of all of the different object properties available.

Specified by:

getAllPropertyTypes in interface ISeriesStyle

Returns:

Set A list of all of the property types available. Returns an empty set if there are no properties for the given series style.

getProperty

public java.lang.Object getProperty(java.lang.String propertyType)

Description copied from interface: ISeriesStyle

Gets the property value for the specified property type. Note that it is up to the implementation to show which property types are available.

Specified by:

getProperty in interface ISeriesStyle

Parameters:

propertyType - The name of the property to fetch.

Returns:

Object The value of the specified property, or null if no property by the specified name was found.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setProperty

public boolean setProperty(java.lang.String propertyType,
                           java.lang.Object value)

Description copied from interface: ISeriesStyle

Sets the property value for the specified property name. Note that it is up to the implementation to show which property types are available.

Specified by:

setProperty in interface ISeriesStyle

Parameters:

propertyType - The name of the property to set.

value - The new value of the property to set.

Returns:

boolean Returns true if the property existed and the value was successfully set, false if otherwise.