org.graffiti.graphics
Class PortsAttribute

java.lang.Object
  extended by org.graffiti.attributes.AbstractAttribute
      extended by org.graffiti.attributes.AbstractCollectionAttribute
          extended by org.graffiti.attributes.HashMapAttribute
              extended by org.graffiti.graphics.PortsAttribute
All Implemented Interfaces:
Attribute, CollectionAttribute, DeepCopy, GraphicAttributeConstants, Displayable<Object>

public class PortsAttribute
extends HashMapAttribute
implements GraphicAttributeConstants

Contains ingoing, outgoing and common ports

Version:
$Revision: 5808 $
Author:
breu

Field Summary
 
Fields inherited from class org.graffiti.attributes.AbstractCollectionAttribute
attributes
 
Fields inherited from class org.graffiti.attributes.AbstractAttribute
id
 
Fields inherited from interface org.graffiti.graphics.GraphicAttributeConstants
ABSOLUTE_X_OFFSET, ABSOLUTE_Y_OFFSET, ALIGNMENT, ALIGNMENT_SEGMENT, ALIGNMENT_X, ALIGNMENT_Y, ARROWHEAD, ARROWSHAPE_CLASSNAME, ARROWTAIL, BEND, BENDS, BENDS_PATH, BGIMAGE, BGIMAGE_PATH, BLUE, BOTTOM_INSIDE, BOTTOM_OUTSIDE, CENTERED, CIRCLE_CENTER, CIRCLE_CENTER_PATH, CIRCLE_CLASSNAME, CIRCLE_LINE_SEGMENTATION_CLASSNAME, CIRCLE_LINE_SEGMENTATION_SHAPE, COMMON, COORD_PATH, COORDINATE, COORDX_PATH, COORDY_PATH, COORDZ_PATH, CUBICSPLINE, CUBICSPLINE_CLASSNAME, DEFAULT_CAP, DEFAULT_EDGE_FILLCOLOR, DEFAULT_EDGE_FRAMECOLOR, DEFAULT_EDGE_FRAMETHICKNESS, DEFAULT_EDGE_THICKNESS, DEFAULT_FONT_SIZE, DEFAULT_GRAPHIC_ELEMENT_FRAMECOLOR, DEFAULT_GRAPHIC_ELEMENT_FRAMETHICKNESS, DEFAULT_JOIN, DEFAULT_MAX_WIDTH, DEFAULT_MITER, DEFAULT_NODE_FILLCOLOR, DEFAULT_NODE_FRAMECOLOR, DEFAULT_NODE_FRAMETHICKNESS, DEFAULT_NODE_SHAPE, DEFAULT_NODE_SIZE, DEPTH, DEPTH_PATH, DIM_PATH, DIMENSION, DIMH_PATH, DIMW_PATH, DOCKING, DOCKING_PATH, EDGE, ELLIPSE_CLASSNAME, END_ANGLE, FILLCOLOR, FILLCOLOR_PATH, FONT, FONT_SIZE, FRAMECOLOR, FRAMETHICKNESS, FRAMETHICKNESS_PATH, GRAPHICS, GREEN, GRID, GRID_PATH, HEIGHT, IMAGE, IN, INTRA_LEVEL_CLASSNAME, LABEL, LABEL_ATTRIBUTE_PATH, LABEL_DISTANCE, LEFT_INSIDE, LEFT_OUTSIDE, LEVEL, LINE_POINT_PATH, LINEMODE, LINEMODE_PATH, LINETYPE, LINEWIDTH_PATH, MAX_WIDTH, MAXIMIZE, NAME, NEARSOURCE, NEARTARGET, NODE, OFFSET, OPAC, OUT, OUTLINE_PATH, POLYCLOSED_CLASSNAME, POLYLINE, POLYLINE_CLASSNAME, PORT, PORTS, PORTS_PATH, POSITION, QUAD_CURVE_EDGE_SHAPE, RECTANGLE_CLASSNAME, RED, REF, RELATIVE_ALIGNMENT, RELATIVE_X_OFFSET, RELATIVE_Y_OFFSET, RIGHT_INSIDE, RIGHT_OUTSIDE, ROTATION, SHAPE, SHAPE_DESC_PATH, SHAPE_PATH, SHAPEDESCRIPTION, SMOOTH_CLASSNAME, SMOOTH_LINE_EDGE_SHAPE, SMOOTHLINE, SOURCE, SPIRAL_CLASSNAME, SQUARESPLINE, SQUARESPLINE_CLASSNAME, START_ANGLE, STRAIGHT_LINE_EDGE_SHAPE, STRAIGHTLINE, STRAIGHTLINE_CLASSNAME, TARGET, TEXTCOLOR, THICKNESS, THICKNESS_PATH, TILED, TOP_INSIDE, TOP_OUTSIDE, WIDTH, X, Y, Z
 
Fields inherited from interface org.graffiti.attributes.Attribute
SEPARATOR
 
Constructor Summary
PortsAttribute(String id)
          Constructor for Ports.
PortsAttribute(String id, CollectionAttribute i, CollectionAttribute o, CollectionAttribute c)
          Constructor for Ports.
 
Method Summary
 Object copy()
          Returns a deep copy of this object.
 CollectionAttribute getCommon()
          Returns the 'common'-value of the encapsulated ports.
 CollectionAttribute getIngoing()
          Returns the 'ingoing'-value of the encapsulated ports.
 CollectionAttribute getOutgoing()
          Returns the 'outgoing'-value of the encapsulated ports.
 PortAttribute getPort(String name, boolean out)
          Look if there is a PortAttribute in this CollectionAttribute called name.
 void setCollection(Map<String,Attribute> attrs)
          Sets the collection of attributes contained within this CollectionAttribute
 void setCommon(CollectionAttribute c)
          Sets the 'common'-value.
 void setCommonPorts(List<Port> ports)
          DOCUMENT ME!
 void setIngoing(CollectionAttribute i)
          Sets the 'ingoing'-value.
 void setIngoingPorts(List<Port> ports)
          DOCUMENT ME!
 void setOutgoing(CollectionAttribute o)
          Sets the 'outgoing'-value.
 void setOutgoingPorts(List<Port> ports)
          DOCUMENT ME!
 
Methods inherited from class org.graffiti.attributes.HashMapAttribute
doSetValue, getCollection, setDefaultValue
 
Methods inherited from class org.graffiti.attributes.AbstractCollectionAttribute
add, add, containsAttribute, getAttributable, getAttribute, getValue, isEmpty, remove, remove, setAttributable, toString, toXMLString
 
Methods inherited from class org.graffiti.attributes.AbstractAttribute
callPostAttributeAdded, callPostAttributeChanged, callPostAttributeRemoved, callPreAttributeAdded, callPreAttributeChanged, callPreAttributeRemoved, getDescription, getId, getName, getParent, getPath, getSpaces, getStandardXML, setDescription, setParent, setValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.graffiti.attributes.CollectionAttribute
add, add, containsAttribute, getAttribute, isEmpty, remove, remove, setAttributable
 
Methods inherited from interface org.graffiti.attributes.Attribute
getAttributable, getId, getParent, getPath, getValue, setParent, setValue, toString
 
Methods inherited from interface org.graffiti.plugin.Displayable
getDescription, getName, setDescription, toXMLString
 

Constructor Detail

PortsAttribute

public PortsAttribute(String id)
Constructor for Ports.

Parameters:
id - the id of the attribute.

PortsAttribute

public PortsAttribute(String id,
                      CollectionAttribute i,
                      CollectionAttribute o,
                      CollectionAttribute c)
Constructor for Ports.

Parameters:
id - the id of the attribute.
i - the ingoing-value of the attribute.
o - the outgoing-value of the attribute.
c - the common-value of the attribute.
Method Detail

setCollection

public void setCollection(Map<String,Attribute> attrs)
Sets the collection of attributes contained within this CollectionAttribute

Specified by:
setCollection in interface CollectionAttribute
Overrides:
setCollection in class HashMapAttribute
Parameters:
attrs - the map that contains all attributes.
Throws:
IllegalArgumentException - DOCUMENT ME!

setCommon

public void setCommon(CollectionAttribute c)
Sets the 'common'-value.

Parameters:
c - the 'common'-value to be set.

getCommon

public CollectionAttribute getCommon()
Returns the 'common'-value of the encapsulated ports.

Returns:
the 'common'-value of the encapsulated ports.

setCommonPorts

public void setCommonPorts(List<Port> ports)
DOCUMENT ME!

Parameters:
ports - DOCUMENT ME!

setIngoing

public void setIngoing(CollectionAttribute i)
Sets the 'ingoing'-value.

Parameters:
i - the 'ingoing'-value to be set.

getIngoing

public CollectionAttribute getIngoing()
Returns the 'ingoing'-value of the encapsulated ports.

Returns:
the 'ingoing'-value of the encapsulated ports.

setIngoingPorts

public void setIngoingPorts(List<Port> ports)
DOCUMENT ME!

Parameters:
ports - DOCUMENT ME!

setOutgoing

public void setOutgoing(CollectionAttribute o)
Sets the 'outgoing'-value.

Parameters:
o - the 'outgoing'-value to be set.

setOutgoingPorts

public void setOutgoingPorts(List<Port> ports)
DOCUMENT ME!

Parameters:
ports - DOCUMENT ME!

getOutgoing

public CollectionAttribute getOutgoing()
Returns the 'outgoing'-value of the encapsulated ports.

Returns:
the 'outgoing'-value of the encapsulated ports.

getPort

public PortAttribute getPort(String name,
                             boolean out)
Look if there is a PortAttribute in this CollectionAttribute called name. Returns null if there is no such attribute.

Parameters:
name - the name of the port attribute wanted.
out - DOCUMENT ME!
Returns:
the PortAttribute named name or null if no such attribute exists.

copy

public Object copy()
Returns a deep copy of this object.

Specified by:
copy in interface DeepCopy
Overrides:
copy in class HashMapAttribute
Returns:
A deep copy of this object.


Generated at 2012-05-30 11:00:36 PM CEST