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

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

All Implemented Interfaces:

Serializable

public class Ring
extends Object
implements Serializable

Provides the x, y coordiante locations of a polygon feature.

See Also:

Serialized Form

Constructor Summary

Ring()
Constructs an instance of a Ring object.

Method Summary

void	addHoles(Hole obj) Adds the given Hole object to the Ring object's Holes collection.
void	clearHoles() Clears all Hole objects from the Holes collection.
Hole	getHole(int index) Returns a Hole object at given index from the Holes collection.
int	getHolesCount() Returns the count of Hole objects in the Holes collection.
Points	getPoints() Returns the Point object associated with this Ring object.
void	removeHole(int index) Removes a Hole object at given index from the Holes collection.
void	setPoints(Points object) Sets the given points object to the Ring object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ring

public Ring()

Constructs an instance of a Ring object. Example: Ring ring = new Ring();

Method Detail

setPoints

public void setPoints(Points object)

Sets the given points object to the Ring object. Example:

 Point point = new Point();
 point.setX(-125.00);
 point.setY(45.0);
 Points points = new Points();
 points.addPointObject(point);
 ring.setPoints(points);
 

Parameters:

object - the Points object;

See Also:

getPoints()

getPoints

public Points getPoints()

Returns the Point object associated with this Ring object. Example:

 Points points = ring.getPoints();
 

Returns:

Points

See Also:

setPoints(com.esri.aims.mtier.model.acetate.Points)

addHoles

public void addHoles(Hole obj)

Adds the given Hole object to the Ring object's Holes collection. Example:

 Point pnt = new Point();
 pnt.setX(-125.00);
 pnt.setY(45.0);
 Points pnts = new Points();
 pnts.addPointObject(pnt);
 Hole hole = new Hole();
 hole.setPoints(pnts);
 ring.addHoles(hole);
 

Parameters:

obj - the Hole object.

See Also:

getHole(int), removeHole(int), clearHoles()

getHolesCount

public int getHolesCount()

Returns the count of Hole objects in the Holes collection. Example: int holesCount = Ring.getHolesCount();

Returns:

int

getHole

public Hole getHole(int index)

Returns a Hole object at given index from the Holes collection. Example:

 Hole hole = ring.getHole(2);
 

Parameters:

index - the item in the collection

Returns:

Hole

See Also:

addHoles(com.esri.aims.mtier.model.acetate.Hole)

removeHole

public void removeHole(int index)

Removes a Hole object at given index from the Holes collection. Example: ring.removeHole(2);

Parameters:

index - the item in the collection

See Also:

clearHoles(), addHoles(com.esri.aims.mtier.model.acetate.Hole)

clearHoles

public void clearHoles()

Clears all Hole objects from the Holes collection. Example: ring.clearHoles();

See Also:

removeHole(int), addHoles(com.esri.aims.mtier.model.acetate.Hole)