Package org.apache.commons.geometry.spherical.twod

Class AbstractGreatArcConnector.ConnectableGreatArc

java.lang.Object

org.apache.commons.geometry.euclidean.internal.AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

org.apache.commons.geometry.spherical.twod.AbstractGreatArcConnector.ConnectableGreatArc

All Implemented Interfaces:

java.lang.Comparable<AbstractGreatArcConnector.ConnectableGreatArc>

Enclosing class:

AbstractGreatArcConnector

protected static class AbstractGreatArcConnector.ConnectableGreatArc
extends AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Internal class for connecting GreatArcs into GreatArcPaths.

Field Summary

Fields

Modifier and Type	Field	Description
private GreatArc	arc	Great arc for this instance.
private Point2S	start	Segment start point.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ConnectableGreatArc(GreatArc arc)	Create a new instance from the given arc.
	ConnectableGreatArc(Point2S start)	Create a new instance with the given start point.
private	ConnectableGreatArc(Point2S start, GreatArc arc)	Create a new instance with the given start point and arc.

Method Summary

Modifier and Type	Method	Description
boolean	canConnectTo(AbstractGreatArcConnector.ConnectableGreatArc next)	Return true if this instance's end point can be connected to the argument's start point.
int	compareTo(AbstractGreatArcConnector.ConnectableGreatArc other)
boolean	endPointsEq(AbstractGreatArcConnector.ConnectableGreatArc other)	Return true if the end point of this instance should be considered equivalent to the end point of the argument.
boolean	equals(java.lang.Object obj)
GreatArc	getArc()	Get the arc for the instance.
AbstractGreatArcConnector.ConnectableGreatArc	getConnectionSearchKey()	Get a new instance used as a search key to help locate other elements with start points matching this instance's end point.
double	getRelativeAngle(AbstractGreatArcConnector.ConnectableGreatArc other)	Return the relative angle between this element and the argument.
protected AbstractGreatArcConnector.ConnectableGreatArc	getSelf()	Return the current instance as the generic type.
boolean	hasEnd()	Return true if this instance has an end point that can be connected to another element's start point.
int	hashCode()
boolean	hasStart()	Return true if this instance has a start point that can be connected to another element's end point.
boolean	hasZeroSize()	Return true if this instance has a size equivalent to zero.
boolean	shouldContinueConnectionSearch(AbstractGreatArcConnector.ConnectableGreatArc candidate, boolean ascending)	Return true if the search for possible connections should continue through the sorted set of possible path elements given the current candidate element and search direction.

Methods inherited from class org.apache.commons.geometry.euclidean.internal.AbstractPathConnector.ConnectableElement

connectTo, exportPath, getNext, getPrevious, hasNext, hasPrevious, markExported, setNext, setPrevious

Methods inherited from class java.lang.Object

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

Field Detail

start

private final Point2S start

Segment start point. This will be used to connect to other path elements.

arc

private final GreatArc arc

Great arc for this instance.

Constructor Detail

ConnectableGreatArc

public ConnectableGreatArc(Point2S start)

Create a new instance with the given start point. This constructor is intended only for performing searches for other path elements.

Parameters:

start - start point

ConnectableGreatArc

public ConnectableGreatArc(GreatArc arc)

Create a new instance from the given arc.

Parameters:

arc - arc for the instance

ConnectableGreatArc

private ConnectableGreatArc(Point2S start,
                            GreatArc arc)

Create a new instance with the given start point and arc.

Parameters:

start - start point

arc - arc for the instance

Method Detail

getArc

public GreatArc getArc()

Get the arc for the instance.

Returns:

the arc for the instance

hasStart

public boolean hasStart()

Return true if this instance has a start point that can be connected to another element's end point.

Specified by:

hasStart in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Returns:

true if this instance has a start point that can be connected to another element's end point

hasEnd

public boolean hasEnd()

Return true if this instance has an end point that can be connected to another element's start point.

Specified by:

hasEnd in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Returns:

true if this instance has an end point that can be connected to another element's start point

endPointsEq

public boolean endPointsEq(AbstractGreatArcConnector.ConnectableGreatArc other)

Return true if the end point of this instance should be considered equivalent to the end point of the argument.

Specified by:

endPointsEq in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Parameters:

other - element to compare end points with

Returns:

true if this instance has an end point equivalent to that of the argument

hasZeroSize

public boolean hasZeroSize()

Return true if this instance has a size equivalent to zero.

Returns:

true if this instance has a size equivalent to zero.

canConnectTo

public boolean canConnectTo(AbstractGreatArcConnector.ConnectableGreatArc next)

Return true if this instance's end point can be connected to the argument's start point.

Specified by:

canConnectTo in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Parameters:

next - candidate for the next element in the path; this value is guaranteed to not be null and to contain a start point

Returns:

true if this instance's end point can be connected to the argument's start point

getRelativeAngle

public double getRelativeAngle(AbstractGreatArcConnector.ConnectableGreatArc other)

Return the relative angle between this element and the argument.

Specified by:

getRelativeAngle in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Parameters:

other - element to compute the angle with

Returns:

the relative angle between this element and the argument

getConnectionSearchKey

public AbstractGreatArcConnector.ConnectableGreatArc getConnectionSearchKey()

Get a new instance used as a search key to help locate other elements with start points matching this instance's end point. The only restriction on the returned instance is that it be compatible with the implementation class' Comparable.compareTo(Object) method.

Specified by:

getConnectionSearchKey in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Returns:

a new instance used to help locate other path elements with start points equivalent to this instance's end point

shouldContinueConnectionSearch

public boolean shouldContinueConnectionSearch(AbstractGreatArcConnector.ConnectableGreatArc candidate,
                                              boolean ascending)

Return true if the search for possible connections should continue through the sorted set of possible path elements given the current candidate element and search direction. The search operation stops for the given direction when this method returns false.

Specified by:

shouldContinueConnectionSearch in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Parameters:

candidate - last tested candidate connection element

ascending - true if the search is proceeding in an ascending direction; false otherwise

Returns:

true if the connection search should continue

compareTo

public int compareTo(AbstractGreatArcConnector.ConnectableGreatArc other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getSelf

protected AbstractGreatArcConnector.ConnectableGreatArc getSelf()

Return the current instance as the generic type.

Specified by:

getSelf in class AbstractPathConnector.ConnectableElement<AbstractGreatArcConnector.ConnectableGreatArc>

Returns:

the current instance as the generic type.