Package repast.simphony.visualization.engine

Class BasicDisplayDescriptor

java.lang.Object

repast.simphony.scenario.AbstractDescriptor

repast.simphony.visualization.engine.BasicDisplayDescriptor

All Implemented Interfaces:

Descriptor, DisplayDescriptor

Direct Known Subclasses:

CartesianDisplayDescriptor, GISDisplayDescriptor

public abstract class BasicDisplayDescriptor
extends AbstractDescriptor
implements DisplayDescriptor

Basic Display descriptor implementation. TODO Projections: also implement network descriptor?

Author:

Nick Collier, Eric Tatara

Field Summary

Fields inherited from class repast.simphony.scenario.AbstractDescriptor

scs

Constructor Summary

Constructors

Constructor	Description
BasicDisplayDescriptor(String name)
BasicDisplayDescriptor(DisplayDescriptor descriptor)

Method Summary

Modifier and Type	Method	Description
void	addEditedStyle(String objClassName, String userStyleName)
void	addLayerOrder(String objClassName, int order)
void	addNetworkEditedStyle(Object networkID, String networkClassName)
void	addNetworkStyle(Object networkID, String networkClassName)
void	addProjection(ProjectionData data, ProjectionDescriptor descriptor)	Adds the data for a projection for which this is the display info.
void	addStyle(String objClassName, String styleClassName)
Iterable<String>	agentClassEditedStyleNames()
Iterable<String>	agentClassLayerOrders()
Iterable<String>	agentClassStyleNames()
void	clearProjectionDescriptors()	Removes any added projection descriptors.
void	clearProjections()
Color	getBackgroundColor()	Gets the background color of the display.
BoundingBox	getBoundingBox()	Gets the Bounding Box for the display.
Class<?>[]	getDefaultNetStyles()
Class<?>[]	getDefaultStyles()
String	getDisplayType()
String	getEditedStyleName(String objClassName)
Map<String,String>	getEditedStyles()
Integer	getLayerOrder(String objClassName)
Map<String,Integer>	getLayerOrders()
String	getLayoutClassName()
IDisplay.LayoutFrequency	getLayoutFrqeuency()
int	getLayoutInterval()
String	getLayoutProjection()	Gets the name of the projection associated with the layout.
VisualizationProperties	getLayoutProperties()
String	getNetworkEditedStyleName(Object networkID)
String	getNetworkStyleClassName(Object networkID)
int	getProjectionCount()	Gets the number of projections in this display descriptor.
ProjectionDescriptor	getProjectionDescriptor(String name)	Gets the ProjectionDescriptor for the named projection.
Iterable<ProjectionDescriptor>	getProjectionDescriptors()
Iterable<ProjectionData>	getProjections()	Gets the data for all the projections for which this is the display info.
Object	getProperty(String name)	Gets the named property.
ScheduleParameters	getScheduleParameters()	Retrieves the parameters for when to activate the display update.
String	getStyleClassName(String objClassName)
Map<String,String>	getStyles()
Iterable<Object>	networkEditedStyleIDs()
Iterable<Object>	networkStyleIDs()
Iterable<String>	propertyNames()	Gets an iterable of names of the properties contained by this descriptor.
void	set(DisplayDescriptor descriptor)	Sets the fields of this descriptor from another when making copies.
void	setBackgroundColor(Color color)	Sets the background color of the display.
void	setBoundingBox(BoundingBox boundingBox)	Sets the BoundingBox for the display.
void	setDisplayType(String type, boolean reset)	Sets the display type of this descriptor.
void	setLayoutClassName(String className)
void	setLayoutFrequency(IDisplay.LayoutFrequency frequency)
void	setLayoutInterval(int interval)
void	setLayoutProjection(String layoutProjection)	Sets the name of the projection to associate with the layout.
void	setLayoutProperties(VisualizationProperties props)	Sets the layout properties for this display.
void	setProperty(String name, Object value)	Sets the specified property.
void	setScheduleParameters(ScheduleParameters scheduleInfo)	Sets the parameters for when to activate the display update.

Methods inherited from class repast.simphony.scenario.AbstractDescriptor

addScenarioChangedListener, getName, readResolve, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface repast.simphony.engine.schedule.Descriptor

getName, setName

Methods inherited from interface repast.simphony.visualization.engine.DisplayDescriptor

addScenarioChangedListener, makeCopy

Constructor Detail

BasicDisplayDescriptor

public BasicDisplayDescriptor(DisplayDescriptor descriptor)

BasicDisplayDescriptor

public BasicDisplayDescriptor(String name)

Method Detail

getProjections

public Iterable<ProjectionData> getProjections()

Gets the data for all the projections for which this is the display info.

Specified by:

getProjections in interface DisplayDescriptor

Returns:

the data for all the projections for which this is the display info.

getProjectionCount

public int getProjectionCount()

Description copied from interface: DisplayDescriptor

Gets the number of projections in this display descriptor.

Specified by:

getProjectionCount in interface DisplayDescriptor

Returns:

the number of projections in this display descriptor.

addProjection

public void addProjection(ProjectionData data,
                          ProjectionDescriptor descriptor)

Adds the data for a projection for which this is the display info.

Specified by:

addProjection in interface DisplayDescriptor

Parameters:

data -

descriptor -

clearProjections

public void clearProjections()

Specified by:

clearProjections in interface DisplayDescriptor

getProjectionDescriptor

public ProjectionDescriptor getProjectionDescriptor(String name)

Gets the ProjectionDescriptor for the named projection.

Specified by:

getProjectionDescriptor in interface DisplayDescriptor

Parameters:

name - the name of the projection whose descriptor we want

Returns:

the ProjectionDescriptor for the named projection.

clearProjectionDescriptors

public void clearProjectionDescriptors()

Removes any added projection descriptors.

Specified by:

clearProjectionDescriptors in interface DisplayDescriptor

getProjectionDescriptors

public Iterable<ProjectionDescriptor> getProjectionDescriptors()

Specified by:

getProjectionDescriptors in interface DisplayDescriptor

set

public void set(DisplayDescriptor descriptor)

Sets the fields of this descriptor from another when making copies.

Specified by:

set in interface DisplayDescriptor

Parameters:

descriptor -

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface DisplayDescriptor

setDisplayType

public void setDisplayType(String type,
                           boolean reset)

Description copied from interface: DisplayDescriptor

Sets the display type of this descriptor. If reset is true, then the fields in the descriptor that depend on type info will be reset.

Specified by:

setDisplayType in interface DisplayDescriptor

Parameters:

type - the display type

reset - if true, then the fields in the descriptor that depend on type info will be reset.

addStyle

public void addStyle(String objClassName,
                     String styleClassName)

Specified by:

addStyle in interface DisplayDescriptor

addEditedStyle

public void addEditedStyle(String objClassName,
                           String userStyleName)

Specified by:

addEditedStyle in interface DisplayDescriptor

addNetworkStyle

public void addNetworkStyle(Object networkID,
                            String networkClassName)

Specified by:

addNetworkStyle in interface DisplayDescriptor

addNetworkEditedStyle

public void addNetworkEditedStyle(Object networkID,
                                  String networkClassName)

Specified by:

addNetworkEditedStyle in interface DisplayDescriptor

getStyleClassName

public String getStyleClassName(String objClassName)

Specified by:

getStyleClassName in interface DisplayDescriptor

getEditedStyleName

public String getEditedStyleName(String objClassName)

Specified by:

getEditedStyleName in interface DisplayDescriptor

getNetworkStyleClassName

public String getNetworkStyleClassName(Object networkID)

Specified by:

getNetworkStyleClassName in interface DisplayDescriptor

getNetworkEditedStyleName

public String getNetworkEditedStyleName(Object networkID)

Specified by:

getNetworkEditedStyleName in interface DisplayDescriptor

agentClassStyleNames

public Iterable<String> agentClassStyleNames()

Specified by:

agentClassStyleNames in interface DisplayDescriptor

agentClassEditedStyleNames

public Iterable<String> agentClassEditedStyleNames()

Specified by:

agentClassEditedStyleNames in interface DisplayDescriptor

networkStyleIDs

public Iterable<Object> networkStyleIDs()

Specified by:

networkStyleIDs in interface DisplayDescriptor

networkEditedStyleIDs

public Iterable<Object> networkEditedStyleIDs()

Specified by:

networkEditedStyleIDs in interface DisplayDescriptor

getLayoutFrqeuency

public IDisplay.LayoutFrequency getLayoutFrqeuency()

Specified by:

getLayoutFrqeuency in interface DisplayDescriptor

setLayoutFrequency

public void setLayoutFrequency(IDisplay.LayoutFrequency frequency)

Specified by:

setLayoutFrequency in interface DisplayDescriptor

getScheduleParameters

public ScheduleParameters getScheduleParameters()

Description copied from interface: DisplayDescriptor

Retrieves the parameters for when to activate the display update.

Specified by:

getScheduleParameters in interface DisplayDescriptor

Returns:

the parameters for when to activate the display update.

setScheduleParameters

public void setScheduleParameters(ScheduleParameters scheduleInfo)

Description copied from interface: DisplayDescriptor

Sets the parameters for when to activate the display update.

Specified by:

setScheduleParameters in interface DisplayDescriptor

Parameters:

scheduleInfo - when to activate the display update

getLayoutClassName

public String getLayoutClassName()

Specified by:

getLayoutClassName in interface DisplayDescriptor

setLayoutClassName

public void setLayoutClassName(String className)

Specified by:

setLayoutClassName in interface DisplayDescriptor

getLayoutProjection

public String getLayoutProjection()

Description copied from interface: DisplayDescriptor

Gets the name of the projection associated with the layout.

Specified by:

getLayoutProjection in interface DisplayDescriptor

Returns:

the name of the projection associated with the layout.

setLayoutProjection

public void setLayoutProjection(String layoutProjection)

Description copied from interface: DisplayDescriptor

Sets the name of the projection to associate with the layout.

Specified by:

setLayoutProjection in interface DisplayDescriptor

setLayoutInterval

public void setLayoutInterval(int interval)

Specified by:

setLayoutInterval in interface DisplayDescriptor

getLayoutInterval

public int getLayoutInterval()

Specified by:

getLayoutInterval in interface DisplayDescriptor

getLayoutProperties

public VisualizationProperties getLayoutProperties()

Specified by:

getLayoutProperties in interface DisplayDescriptor

Returns:

hints for displaying a grid.

setLayoutProperties

public void setLayoutProperties(VisualizationProperties props)

Sets the layout properties for this display.

Specified by:

setLayoutProperties in interface DisplayDescriptor

getBoundingBox

public BoundingBox getBoundingBox()

Gets the Bounding Box for the display. This defines the extents of the display

Specified by:

getBoundingBox in interface DisplayDescriptor

Returns:

the BoundingBox

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

Sets the BoundingBox for the display. This defines the extents of the display.

Specified by:

setBoundingBox in interface DisplayDescriptor

Parameters:

boundingBox - The BoundingBox

agentClassLayerOrders

public Iterable<String> agentClassLayerOrders()

Specified by:

agentClassLayerOrders in interface DisplayDescriptor

getLayerOrder

public Integer getLayerOrder(String objClassName)

Specified by:

getLayerOrder in interface DisplayDescriptor

addLayerOrder

public void addLayerOrder(String objClassName,
                          int order)

Specified by:

addLayerOrder in interface DisplayDescriptor

getProperty

public Object getProperty(String name)

Gets the named property.

Specified by:

getProperty in interface DisplayDescriptor

Parameters:

name - the name of the property

Returns:

the named property

setProperty

public void setProperty(String name,
                        Object value)

Sets the specified property.

Specified by:

setProperty in interface DisplayDescriptor

Parameters:

name - the property's name

value - the property's value

propertyNames

public Iterable<String> propertyNames()

Gets an iterable of names of the properties contained by this descriptor.

Specified by:

propertyNames in interface DisplayDescriptor

Returns:

an iterable of names of the properties contained by this descriptor.

getStyles

public Map<String,String> getStyles()

Specified by:

getStyles in interface DisplayDescriptor

getBackgroundColor

public Color getBackgroundColor()

Description copied from interface: DisplayDescriptor

Gets the background color of the display.

Specified by:

getBackgroundColor in interface DisplayDescriptor

Returns:

the background color of the display.

setBackgroundColor

public void setBackgroundColor(Color color)

Description copied from interface: DisplayDescriptor

Sets the background color of the display.

Specified by:

setBackgroundColor in interface DisplayDescriptor

Parameters:

color - the background color of the display.

getLayerOrders

public Map<String,Integer> getLayerOrders()

Specified by:

getLayerOrders in interface DisplayDescriptor

getEditedStyles

public Map<String,String> getEditedStyles()

Specified by:

getEditedStyles in interface DisplayDescriptor

getDefaultStyles

public Class<?>[] getDefaultStyles()

Specified by:

getDefaultStyles in interface DisplayDescriptor

getDefaultNetStyles

public Class<?>[] getDefaultNetStyles()

Specified by:

getDefaultNetStyles in interface DisplayDescriptor