CircularRing (Geotools modules 21.0 API)

Object
- Geometry
- - LineString
  - - LinearRing
    - - CircularRing

All Implemented Interfaces:

Serializable, Cloneable, Comparable, CurvedGeometry<LinearRing>, CurvedRing, SingleCurvedGeometry<LinearRing>, Lineal
```
public class CircularRing
extends LinearRing
implements SingleCurvedGeometry<LinearRing>, CurvedRing
```
A CircularRing is a CircularString whose start and end point coincide. The ring needs to be formed of at least two arc circles, in order to be able to determine its orientation.

Author:

Andrea Aime - GeoSolutions

See Also:

Serialized Form

Field Summary
- Fields inherited from class LinearRing
  MINIMUM_VALID_SIZE
- Fields inherited from class LineString
  points
- Fields inherited from class Geometry
  envelope, factory, SRID

Constructor Summary

Constructors
Constructor and Description
`CircularRing(CoordinateSequence points, GeometryFactory factory, double tolerance)`
`CircularRing(double[] controlPoints, GeometryFactory factory, double tolerance)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(CoordinateFilter filter)`
`void`	`apply(CoordinateSequenceFilter filter)`
`void`	`apply(GeometryComponentFilter filter)`
`void`	`apply(GeometryFilter filter)`
`Geometry`	`buffer(double distance)`
`Geometry`	`buffer(double distance, int quadrantSegments)`
`Geometry`	`buffer(double distance, int quadrantSegments, int endCapStyle)`
`int`	`compareTo(Object o)`
`int`	`compareTo(Object o, CoordinateSequenceComparator comp)`
`protected Envelope`	`computeEnvelopeInternal()`
`boolean`	`contains(Geometry g)`
`Geometry`	`convexHull()`
`CircularRing`	`copyInternal()`
`boolean`	`coveredBy(Geometry g)`
`boolean`	`covers(Geometry g)`
`boolean`	`crosses(Geometry g)`
`Geometry`	`difference(Geometry other)`
`boolean`	`disjoint(Geometry g)`
`double`	`distance(Geometry g)`
`boolean`	`equals(Geometry other)`
`boolean`	`equals(Object o)`
`boolean`	`equalsExact(Geometry other)`
`boolean`	`equalsExact(Geometry other, double tolerance)`
`boolean`	`equalsNorm(Geometry g)`
`boolean`	`equalsTopo(Geometry other)`
`void`	`geometryChanged()`
`CircularArc`	`getArcN(int arcIndex)` Returns the n-th circular arc making up the geometry
`double`	`getArea()`
`Geometry`	`getBoundary()`
`int`	`getBoundaryDimension()`
`Point`	`getCentroid()`
`double[]`	`getControlPoints()` Returns the control points for this string/ring.
`Coordinate`	`getCoordinate()`
`Coordinate`	`getCoordinateN(int n)`
`Coordinate[]`	`getCoordinates()`
`int`	`getCoordinatesDimension()` Returns the dimension of the geometry without forcing access to the coordinate sequence
`CoordinateSequence`	`getCoordinateSequence()`
`int`	`getDimension()`
`Point`	`getEndPoint()`
`Geometry`	`getEnvelope()`
`Envelope`	`getEnvelopeInternal()`
`GeometryFactory`	`getFactory()`
`Geometry`	`getGeometryN(int n)`
`String`	`getGeometryType()`
`Point`	`getInteriorPoint()`
`double`	`getLength()`
`CoordinateSequence`	`getLinearizedCoordinateSequence(double tolerance)` Returns the linearized coordinates at the given tolerance
`int`	`getNumArcs()` Number of arc circles
`int`	`getNumGeometries()`
`int`	`getNumPoints()`
`Point`	`getPointN(int n)`
`PrecisionModel`	`getPrecisionModel()`
`int`	`getSRID()`
`Point`	`getStartPoint()`
`double`	`getTolerance()` The default linearization tolerance
`Object`	`getUserData()`
`int`	`hashCode()`
`Geometry`	`intersection(Geometry other)`
`boolean`	`intersects(Geometry g)`
`boolean`	`isClosed()`
`boolean`	`isCoordinate(Coordinate pt)`
`boolean`	`isEmpty()`
`boolean`	`isRectangle()`
`boolean`	`isRing()`
`boolean`	`isSimple()`
`boolean`	`isValid()`
`boolean`	`isWithinDistance(Geometry geom, double distance)`
`LinearRing`	`linearize()` Linearizes the geometry using the built-in linearization tolerance
`LinearRing`	`linearize(double tolerance)` Linearizes the geometry using the provided tolerance, the result is guaranteed to be less than tolerance away from the curved geometry unless the number of points needed to linearize the geometry exceeds the build-in per quadrant maximum, see `CircularArc.MAX_SEGMENTS_QUADRANT`
`Geometry`	`norm()`
`void`	`normalize()`
`CircularRing`	`normalizeRing()` Returns a normalized ring (one that does not have a single arc closing on itself)
`boolean`	`overlaps(Geometry g)`
`IntersectionMatrix`	`relate(Geometry g)`
`boolean`	`relate(Geometry g, String intersectionPattern)`
`Geometry`	`reverse()`
`void`	`setSRID(int SRID)`
`void`	`setUserData(Object userData)`
`Geometry`	`symDifference(Geometry other)`
`String`	`toCurvedText()` Parallel method to `Geometry.toText()` that will output the geometry as curved instead of as linear
`String`	`toString()`
`String`	`toText()`
`boolean`	`touches(Geometry g)`
`Geometry`	`union()`
`Geometry`	`union(Geometry other)`
`boolean`	`within(Geometry g)`

Methods inherited from class LinearRing
getSortIndex

Methods inherited from class LineString
clone, compareToSameClass, compareToSameClass, isEquivalentClass

Methods inherited from class Geometry
checkNotGeometryCollection, compare, copy, equal, geometryChangedAction, hasNonEmptyElements, hasNullElements, isGeometryCollection

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CircularRing
```
public CircularRing(CoordinateSequence points,
                    GeometryFactory factory,
                    double tolerance)
```
  - CircularRing
```
public CircularRing(double[] controlPoints,
                    GeometryFactory factory,
                    double tolerance)
```
- Method Detail
  - getNumArcs
```
public int getNumArcs()
```
    Description copied from interface: SingleCurvedGeometry
    
    Number of arc circles
    
    Specified by:
    
    getNumArcs in interface SingleCurvedGeometry<LinearRing>
    
    Returns:
  - getArcN
```
public CircularArc getArcN(int arcIndex)
```
    Description copied from interface: SingleCurvedGeometry
    
    Returns the n-th circular arc making up the geometry
    
    Specified by:
    
    getArcN in interface SingleCurvedGeometry<LinearRing>
    
    Returns:
  - linearize
```
public LinearRing linearize()
```
    Description copied from interface: CurvedGeometry
    
    Linearizes the geometry using the built-in linearization tolerance
    
    Specified by:
    
    linearize in interface CurvedGeometry<LinearRing>
    
    Returns:
  - linearize
```
public LinearRing linearize(double tolerance)
```
    Description copied from interface: CurvedGeometry
    
    Linearizes the geometry using the provided tolerance, the result is guaranteed to be less than tolerance away from the curved geometry unless the number of points needed to linearize the geometry exceeds the build-in per quadrant maximum, see CircularArc.MAX_SEGMENTS_QUADRANT
    
    Specified by:
    
    linearize in interface CurvedGeometry<LinearRing>
    
    Parameters:
    
    tolerance - Linearization tolerance, should be zero or positive. When zero is used, the maximum number of allowed linearization points will be used, see CircularArc.MAX_SEGMENTS_QUADRANT
    
    Returns:
  - getTolerance
```
public double getTolerance()
```
    Description copied from interface: CurvedGeometry
    
    The default linearization tolerance
    
    Specified by:
    
    getTolerance in interface CurvedGeometry<LinearRing>
    
    Returns:
  - getLinearizedCoordinateSequence
```
public CoordinateSequence getLinearizedCoordinateSequence(double tolerance)
```
    Description copied from interface: SingleCurvedGeometry
    
    Returns the linearized coordinates at the given tolerance
    
    Specified by:
    
    getLinearizedCoordinateSequence in interface SingleCurvedGeometry<LinearRing>
    
    Returns:
  - getControlPoints
```
public double[] getControlPoints()
```
    Description copied from interface: SingleCurvedGeometry
    
    Returns the control points for this string/ring.
    
    Specified by:
    
    getControlPoints in interface SingleCurvedGeometry<LinearRing>
    
    Returns:
  - isClosed
```
public boolean isClosed()
```
    Overrides:
    
    isClosed in class LinearRing
  - getDimension
```
public int getDimension()
```
    Overrides:
    
    getDimension in class LineString
  - getBoundaryDimension
```
public int getBoundaryDimension()
```
    Overrides:
    
    getBoundaryDimension in class LinearRing
  - isEmpty
```
public boolean isEmpty()
```
    Overrides:
    
    isEmpty in class LineString
  - getGeometryType
```
public String getGeometryType()
```
    Overrides:
    
    getGeometryType in class LinearRing
  - getCoordinatesDimension
```
public int getCoordinatesDimension()
```
    Description copied from interface: CurvedGeometry
    
    Returns the dimension of the geometry without forcing access to the coordinate sequence
    
    Specified by:
    
    getCoordinatesDimension in interface CurvedGeometry<LinearRing>
    
    Returns:
  - normalizeRing
```
public CircularRing normalizeRing()
```
    Returns a normalized ring (one that does not have a single arc closing on itself)
    
    Returns:
  - reverse
```
public Geometry reverse()
```
    Overrides:
    
    reverse in class LinearRing
  - getNumGeometries
```
public int getNumGeometries()
```
    Overrides:
    
    getNumGeometries in class Geometry
  - getGeometryN
```
public Geometry getGeometryN(int n)
```
    Overrides:
    
    getGeometryN in class Geometry
  - setUserData
```
public void setUserData(Object userData)
```
    Overrides:
    
    setUserData in class Geometry
  - getSRID
```
public int getSRID()
```
    Overrides:
    
    getSRID in class Geometry
  - setSRID
```
public void setSRID(int SRID)
```
    Overrides:
    
    setSRID in class Geometry
  - getFactory
```
public GeometryFactory getFactory()
```
    Overrides:
    
    getFactory in class Geometry
  - getUserData
```
public Object getUserData()
```
    Overrides:
    
    getUserData in class Geometry
  - getPrecisionModel
```
public PrecisionModel getPrecisionModel()
```
    Overrides:
    
    getPrecisionModel in class Geometry
  - isRectangle
```
public boolean isRectangle()
```
    Overrides:
    
    isRectangle in class Geometry
  - getInteriorPoint
```
public Point getInteriorPoint()
```
    Overrides:
    
    getInteriorPoint in class Geometry
  - getEnvelope
```
public Geometry getEnvelope()
```
    Overrides:
    
    getEnvelope in class Geometry
  - getEnvelopeInternal
```
public Envelope getEnvelopeInternal()
```
    Overrides:
    
    getEnvelopeInternal in class Geometry
  - computeEnvelopeInternal
```
protected Envelope computeEnvelopeInternal()
```
    Overrides:
    
    computeEnvelopeInternal in class LineString
  - equalsExact
```
public boolean equalsExact(Geometry other)
```
    Overrides:
    
    equalsExact in class Geometry
  - equalsExact
```
public boolean equalsExact(Geometry other,
                           double tolerance)
```
    Overrides:
    
    equalsExact in class LineString
  - equals
```
public boolean equals(Geometry other)
```
    Overrides:
    
    equals in class Geometry
  - equalsTopo
```
public boolean equalsTopo(Geometry other)
```
    Overrides:
    
    equalsTopo in class Geometry
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Geometry
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Geometry
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Geometry
  - toCurvedText
```
public String toCurvedText()
```
    Description copied from interface: CurvedGeometry
    
    Parallel method to Geometry.toText() that will output the geometry as curved instead of as linear
    
    Specified by:
    
    toCurvedText in interface CurvedGeometry<LinearRing>
    
    Returns:
  - equalsNorm
```
public boolean equalsNorm(Geometry g)
```
    Overrides:
    
    equalsNorm in class Geometry
  - getCoordinates
```
public Coordinate[] getCoordinates()
```
    Overrides:
    
    getCoordinates in class LineString
  - getCoordinateSequence
```
public CoordinateSequence getCoordinateSequence()
```
    Overrides:
    
    getCoordinateSequence in class LineString
  - getCoordinateN
```
public Coordinate getCoordinateN(int n)
```
    Overrides:
    
    getCoordinateN in class LineString
  - getCoordinate
```
public Coordinate getCoordinate()
```
    Overrides:
    
    getCoordinate in class LineString
  - getNumPoints
```
public int getNumPoints()
```
    Overrides:
    
    getNumPoints in class LineString
  - getPointN
```
public Point getPointN(int n)
```
    Overrides:
    
    getPointN in class LineString
  - getStartPoint
```
public Point getStartPoint()
```
    Overrides:
    
    getStartPoint in class LineString
  - getEndPoint
```
public Point getEndPoint()
```
    Overrides:
    
    getEndPoint in class LineString
  - isRing
```
public boolean isRing()
```
    Overrides:
    
    isRing in class LineString
  - getLength
```
public double getLength()
```
    Overrides:
    
    getLength in class LineString
  - getBoundary
```
public Geometry getBoundary()
```
    Overrides:
    
    getBoundary in class LineString
  - isCoordinate
```
public boolean isCoordinate(Coordinate pt)
```
    Overrides:
    
    isCoordinate in class LineString
  - apply
```
public void apply(CoordinateFilter filter)
```
    Overrides:
    
    apply in class LineString
  - apply
```
public void apply(CoordinateSequenceFilter filter)
```
    Overrides:
    
    apply in class LineString
  - apply
```
public void apply(GeometryFilter filter)
```
    Overrides:
    
    apply in class LineString
  - apply
```
public void apply(GeometryComponentFilter filter)
```
    Overrides:
    
    apply in class LineString
  - copyInternal
```
public CircularRing copyInternal()
```
    Overrides:
    
    copyInternal in class LinearRing
  - normalize
```
public void normalize()
```
    Overrides:
    
    normalize in class LineString
  - isSimple
```
public boolean isSimple()
```
    Overrides:
    
    isSimple in class Geometry
  - isValid
```
public boolean isValid()
```
    Overrides:
    
    isValid in class Geometry
  - distance
```
public double distance(Geometry g)
```
    Overrides:
    
    distance in class Geometry
  - isWithinDistance
```
public boolean isWithinDistance(Geometry geom,
                                double distance)
```
    Overrides:
    
    isWithinDistance in class Geometry
  - getArea
```
public double getArea()
```
    Overrides:
    
    getArea in class Geometry
  - getCentroid
```
public Point getCentroid()
```
    Overrides:
    
    getCentroid in class Geometry
  - geometryChanged
```
public void geometryChanged()
```
    Overrides:
    
    geometryChanged in class Geometry
  - disjoint
```
public boolean disjoint(Geometry g)
```
    Overrides:
    
    disjoint in class Geometry
  - touches
```
public boolean touches(Geometry g)
```
    Overrides:
    
    touches in class Geometry
  - intersects
```
public boolean intersects(Geometry g)
```
    Overrides:
    
    intersects in class Geometry
  - crosses
```
public boolean crosses(Geometry g)
```
    Overrides:
    
    crosses in class Geometry
  - within
```
public boolean within(Geometry g)
```
    Overrides:
    
    within in class Geometry
  - contains
```
public boolean contains(Geometry g)
```
    Overrides:
    
    contains in class Geometry
  - overlaps
```
public boolean overlaps(Geometry g)
```
    Overrides:
    
    overlaps in class Geometry
  - covers
```
public boolean covers(Geometry g)
```
    Overrides:
    
    covers in class Geometry
  - coveredBy
```
public boolean coveredBy(Geometry g)
```
    Overrides:
    
    coveredBy in class Geometry
  - relate
```
public boolean relate(Geometry g,
                      String intersectionPattern)
```
    Overrides:
    
    relate in class Geometry
  - relate
```
public IntersectionMatrix relate(Geometry g)
```
    Overrides:
    
    relate in class Geometry
  - buffer
```
public Geometry buffer(double distance)
```
    Overrides:
    
    buffer in class Geometry
  - buffer
```
public Geometry buffer(double distance,
                       int quadrantSegments)
```
    Overrides:
    
    buffer in class Geometry
  - buffer
```
public Geometry buffer(double distance,
                       int quadrantSegments,
                       int endCapStyle)
```
    Overrides:
    
    buffer in class Geometry
  - convexHull
```
public Geometry convexHull()
```
    Overrides:
    
    convexHull in class Geometry
  - intersection
```
public Geometry intersection(Geometry other)
```
    Overrides:
    
    intersection in class Geometry
  - union
```
public Geometry union(Geometry other)
```
    Overrides:
    
    union in class Geometry
  - difference
```
public Geometry difference(Geometry other)
```
    Overrides:
    
    difference in class Geometry
  - symDifference
```
public Geometry symDifference(Geometry other)
```
    Overrides:
    
    symDifference in class Geometry
  - union
```
public Geometry union()
```
    Overrides:
    
    union in class Geometry
  - norm
```
public Geometry norm()
```
    Overrides:
    
    norm in class Geometry
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable
    
    Overrides:
    
    compareTo in class Geometry
  - compareTo
```
public int compareTo(Object o,
                     CoordinateSequenceComparator comp)
```
    Overrides:
    
    compareTo in class Geometry
  - toText
```
public String toText()
```
    Overrides:
    
    toText in class Geometry

Class CircularRing

Field Summary

Fields inherited from class LinearRing

Fields inherited from class LineString

Fields inherited from class Geometry

Constructor Summary

Method Summary

Methods inherited from class LinearRing

Methods inherited from class LineString

Methods inherited from class Geometry

Methods inherited from class Object

Constructor Detail

CircularRing

CircularRing

Method Detail

getNumArcs

getArcN

linearize

linearize

getTolerance

getLinearizedCoordinateSequence

getControlPoints

isClosed

getDimension

getBoundaryDimension

isEmpty

getGeometryType

getCoordinatesDimension

normalizeRing

reverse

getNumGeometries

getGeometryN

setUserData

getSRID

setSRID

getFactory

getUserData

getPrecisionModel

isRectangle

getInteriorPoint

getEnvelope

getEnvelopeInternal

computeEnvelopeInternal

equalsExact

equalsExact

equals

equalsTopo

equals

hashCode

toString

toCurvedText

equalsNorm

getCoordinates

getCoordinateSequence

getCoordinateN

getCoordinate

getNumPoints

getPointN

getStartPoint

getEndPoint

isRing

getLength

getBoundary

isCoordinate

apply

apply

apply

apply

copyInternal

normalize

isSimple

isValid

distance

isWithinDistance

getArea

getCentroid

geometryChanged

disjoint

touches

intersects