com.esri.aims.mtier.model.acetate
Class Points

java.lang.Object
  com.esri.aims.mtier.model.acetate.Object
      com.esri.aims.mtier.model.acetate.Points

All Implemented Interfaces:

AcetateElement, Shape, Serializable

public class Points
extends Object
implements Shape, Serializable

Contains a collection of Point objects. Points are used to generate Polygon, Line, and a group of points as an acetate layer. Points can also be used in a FeatureLayer's Filter object. The Points object extends the Object class in the Acetate package.

See Also:

Serialized Form

Constructor Summary

Points()
Constructs an instance of a Points object.

Method Summary

boolean	addPointObject(Point object) Adds the given Point to this Points collection.
void	clearPointObjects() Clears all Point objects from this Points collection.
int	getCount() Returns the count of Point objects in this Points collection.
Point	getPointObject(int index) Returns the Point object at given index from this Points collection.
Symbol	getSymbol() Returns the symbol object associated with this Points object.
String	getType() Returns the type of acetate object, 'Points'.
void	insertPoints(Point object, int index) Inserts a Point object into the Points collection at the specified index.
Object	removePointObject(int index) Removes the Point at given index from this Points object.
void	setSymbol(Object obj) Assigns a symbol to this Points object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Points

public Points()

Constructs an instance of a Points object.

Example:

Points points = new Points();

Method Detail

getType

public String getType()

Returns the type of acetate object, 'Points'.

Specified by:

getType in interface Shape

Specified by:

getType in class Object

Returns:

String

addPointObject

public boolean addPointObject(Point object)

Adds the given Point to this Points collection.

Example:

 Point pnt = new Point();
 pnt.setX(-125.0);
 pnt.setY(45.0);
 points.addPointObject(pnt);
 

Parameters:

object - the PointObject

Returns:

boolean

See Also:

getPointObject(int)

clearPointObjects

public void clearPointObjects()

Clears all Point objects from this Points collection.

Example:

points.clearPointObjects();

removePointObject

public Object removePointObject(int index)

Removes the Point at given index from this Points object.

Example:

Point point = points.removePointObject(0);

Parameters:

index - the index value.

Returns:

Object

See Also:

insertPoints(com.esri.aims.mtier.model.acetate.Point, int)

insertPoints

public void insertPoints(Point object,
                         int index)

Inserts a Point object into the Points collection at the specified index.

Example:

 Point point = new Point();
 point.setX(-125.0);
 point.setY(45.0);
 points.insertPoints(point, 2);
 

Parameters:

object - the PointObject.

index - the index value.

See Also:

removePointObject(int)

getPointObject

public Point getPointObject(int index)

Returns the Point object at given index from this Points collection.

Example:

 Point point = points.getPointObject(2);
 

Parameters:

index - the index value.

Returns:

PointObject

See Also:

addPointObject(com.esri.aims.mtier.model.acetate.Point)

getCount

public int getCount()

Returns the count of Point objects in this Points collection.

Example:

int count = points.getCount();

Returns:

the count

setSymbol

public void setSymbol(Object obj)

Assigns a symbol to this Points object. The symbol sets the display properties for the individual points.

Example:

 SimpleMarkerSymbol simpleMarker = new SimpleMarkerSymbol();
 simpleMarker.setWidth(15);
 points.setSymbol(simpleMarker);
 

Parameters:

obj - the symbol object

See Also:

getSymbol()

getSymbol

public Symbol getSymbol()

Returns the symbol object associated with this Points object.

Example:

 if(points.getSymbol().getType().equals("SimpleMarker")){
  SimpleMarkerSymbol simpleMarker = (SimpleMarkerSymbol)points.getSymbol();
  }
  

Returns:

Symbol