Module org.apache.sis.referencing
Class DefaultPassThroughOperation
Object
FormattableObject
AbstractIdentifiedObject
AbstractCoordinateOperation
DefaultPassThroughOperation
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,IdentifiedObject,CoordinateOperation,PassThroughOperation,SingleOperation
public class DefaultPassThroughOperation
extends AbstractCoordinateOperation
implements PassThroughOperation
Specifies that a subset of a coordinate tuple is subject to a specific coordinate operation.
- Since:
- 0.6
- See Also:
-
Field Summary
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEYFields inherited from interface CoordinateOperation
COORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefaultPassThroughOperation(Map<String, ?> properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, SingleOperation operation, int firstAffectedCoordinate, int numTrailingCoordinates) Constructs a pass-through operation from a set of properties.protectedCreates a new coordinate operation with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptioncastOrCopy(PassThroughOperation object) Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.protected longInvoked byhashCode()for computing the hash code when first needed.booleanequals(Object object, ComparisonMode mode) Compares this concatenated operation with the specified object for equality.protected StringFormats this coordinate operation in a pseudo-Well Known Text (WKT) format.Class<? extends PassThroughOperation> Returns the GeoAPI interface implemented by this class.Deprecated.May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.int[]Returns the ordered sequence of indices in a source coordinate tuple of the coordinates affected by this pass-through operation.Returns the operation to apply on the subset of a coordinate tuple.Deprecated.May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.Methods inherited from class AbstractCoordinateOperation
castOrCopy, getCoordinateOperationAccuracy, getDomainOfValidity, getInterpolationCRS, getLinearAccuracy, getMathTransform, getOperationVersion, getScope, getSourceCRS, getTargetCRS, getWrapAroundChanges, isDefiningConversionMethods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface CoordinateOperation
getCoordinateOperationAccuracy, getDomainOfValidity, getMathTransform, getOperationVersion, getScope, getSourceCRS, getTargetCRSMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
Constructor Details
-
DefaultPassThroughOperation
public DefaultPassThroughOperation(Map<String, ?> properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, SingleOperation operation, int firstAffectedCoordinate, int numTrailingCoordinates) Constructs a pass-through operation from a set of properties. The properties given in argument follow the same rules than for the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" IdentifierorStringAbstractIdentifiedObject.getName()"identifiers" Identifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()- Parameters:
properties- the properties to be given to the identified object.sourceCRS- the source CRS.targetCRS- the target CRS.operation- the operation to apply on the subset of a coordinate tuple.firstAffectedCoordinate- index of the first affected coordinate.numTrailingCoordinates- number of trailing coordinates to pass through.
-
DefaultPassThroughOperation
Creates a new coordinate operation with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API.This constructor performs a shallow copy, i.e. the properties are not cloned.
- Parameters:
operation- the coordinate operation to copy.- See Also:
-
-
Method Details
-
castOrCopy
Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation. If the given object is already an instance ofDefaultPassThroughOperation, then it is returned unchanged. Otherwise a newDefaultPassThroughOperationinstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other properties contained in the given object are not recursively copied.- Parameters:
object- the object to get as a SIS implementation, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
-
getInterface
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsPassThroughOperation.class.Note for implementers
Subclasses usually do not need to override this method since GeoAPI does not definePassThroughOperationsub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterfacein classAbstractCoordinateOperation- Returns:
PassThroughOperation.classor a user-defined sub-interface.
-
getMethod
Deprecated.May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.- Specified by:
getMethodin interfaceSingleOperation- Returns:
null.
-
getParameterValues
Deprecated.May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.- Specified by:
getParameterValuesin interfaceSingleOperation- Returns:
null.
-
getOperation
Returns the operation to apply on the subset of a coordinate tuple.Upcoming API change
This method is conformant to ISO 19111:2003. But the ISO 19111:2007 revision changed the type fromSingleOperationtoCoordinateOperation. This change may be applied in GeoAPI 4.0. This is necessary for supporting usage ofPassThroughOperationwithConcatenatedOperation.- Specified by:
getOperationin interfacePassThroughOperation- Returns:
- the operation to apply on the subset of a coordinate tuple.
- See Also:
-
getModifiedCoordinates
public int[] getModifiedCoordinates()Returns the ordered sequence of indices in a source coordinate tuple of the coordinates affected by this pass-through operation.- Specified by:
getModifiedCoordinatesin interfacePassThroughOperation- Returns:
- zero-based indices of the modified source coordinates.
- See Also:
-
equals
Compares this concatenated operation with the specified object for equality. If themodeargument isComparisonMode.STRICTorBY_CONTRACT, then all available properties are compared including the domain of validity and the scope.- Specified by:
equalsin interfaceLenientComparable- Overrides:
equalsin classAbstractCoordinateOperation- Parameters:
object- the object to compare tothis.mode-STRICTfor performing a strict comparison, orIGNORE_METADATAfor ignoring properties that do not make a difference in the numerical results of coordinate operations.- Returns:
trueif both objects are equal for the given comparison mode.- See Also:
-
computeHashCode
protected long computeHashCode()Invoked byhashCode()for computing the hash code when first needed. SeeAbstractIdentifiedObject.computeHashCode()for more information.- Overrides:
computeHashCodein classAbstractCoordinateOperation- Returns:
- the hash code value. This value may change in any future Apache SIS version.
-
formatTo
Formats this coordinate operation in a pseudo-Well Known Text (WKT) format. Current format is specific to Apache SIS and may change in any future version if a standard format for pass through operations is defined.- Overrides:
formatToin classAbstractCoordinateOperation- Parameters:
formatter- the formatter to use.- Returns:
- currently
"PassThroughOperation"(may change in any future version). - Since:
- 0.7
- See Also:
-