org.apache.sis.referencing.operation

Class DefaultPassThroughOperation

Object

FormattableObject

AbstractIdentifiedObject

AbstractCoordinateOperation

DefaultPassThroughOperation

All Implemented Interfaces:

Serializable, 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:

Serialized Form

Defined in the sis-referencing module

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface CoordinateOperation

COORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultPassThroughOperation(Map<String,?> properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, SingleOperation operation, int firstAffectedOrdinate, int numTrailingOrdinates) Constructs a single operation from a set of properties.
protected	DefaultPassThroughOperation(PassThroughOperation operation) Creates a new coordinate operation with the same values than the specified one.

Method Summary

Modifier and Type	Method and Description
static DefaultPassThroughOperation	castOrCopy(PassThroughOperation object) Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.
protected long	computeHashCode() Invoked by hash­Code() for computing the hash code when first needed.
boolean	equals(Object object, ComparisonMode mode) Compares this concatenated operation with the specified object for equality.
protected String	formatTo(Formatter formatter) Formats this coordinate operation in a pseudo-Well Known Text (WKT) format.
Class<? extends PassThroughOperation>	getInterface() Returns the GeoAPI interface implemented by this class.
OperationMethod	getMethod() Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.
int[]	getModifiedCoordinates() Returns the ordered sequence of indices in a source coordinate tuple of the coordinates affected by this pass-through operation.
SingleOperation	getOperation() Returns the operation to apply on the subset of a coordinate tuple.
ParameterValueGroup	getParameterValues() Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.

Methods inherited from class AbstractCoordinateOperation

cast­Or­Copy, get­Coordinate­Operation­Accuracy, get­Domain­Of­Validity, get­Interpolation­CRS, get­Linear­Accuracy, get­Math­Transform, get­Operation­Version, get­Scope, get­Source­CRS, get­Target­CRS, get­Wrap­Around­Changes, is­Defining­Conversion

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, get­Alias, get­Description, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface CoordinateOperation

get­Coordinate­Operation­Accuracy, get­Domain­Of­Validity, get­Math­Transform, get­Operation­Version, get­Scope, get­Source­CRS, get­Target­CRS

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Detail

DefaultPassThroughOperation

public DefaultPassThroughOperation(Map<String,?> properties,
                                   CoordinateReferenceSystem sourceCRS,
                                   CoordinateReferenceSystem targetCRS,
                                   SingleOperation operation,
                                   int firstAffectedOrdinate,
                                   int numTrailingOrdinates)

Constructs a single 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"	Identifier or String	AbstractIdentifiedObject.getName()
"identifiers"	Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()

Parameters:

properties - the properties to be given to the identified object.

source­CRS - the source CRS.

target­CRS - the target CRS.

operation - the operation to apply on the subset of a coordinate tuple.

first­Affected­Ordinate - index of the first affected ordinate.

num­Trailing­Ordinates - number of trailing ordinates to pass through.

DefaultPassThroughOperation

protected DefaultPassThroughOperation(PassThroughOperation operation)

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:

cast­Or­Copy(Pass­Through­Operation)

Method Detail

castOrCopy

public static DefaultPassThroughOperation castOrCopy(PassThroughOperation object)

Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation. If the given object is already an instance of Default­Pass­Through­Operation, then it is returned unchanged. Otherwise a new Default­Pass­Through­Operation instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other properties contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

getInterface

public Class<? extends PassThroughOperation> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns Pass­Through­Operation.class.

Note for implementors: Subclasses usually do not need to override this method since GeoAPI does not define Pass­Through­Operation sub-interface. Overriding possibility is left mostly for implementors who wish to extend GeoAPI with their own set of interfaces.

Overrides:

get­Interface in class Abstract­Coordinate­Operation

Returns:

Pass­Through­Operation.class or a user-defined sub-interface.

getMethod

@Deprecated
public OperationMethod getMethod()

Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.

Description copied from class: Abstract­Coordinate­Operation

Returns the operation method. This apply only to Abstract­Single­Operation subclasses, which will make this method public.

Specified by:

get­Method in interface Single­Operation

Returns:

null.

getParameterValues

@Deprecated
public ParameterValueGroup getParameterValues()

Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.

Description copied from class: Abstract­Coordinate­Operation

Returns the parameter values. The default implementation infers the parameter values from the AbstractCoordinateOperation.transform, if possible.

Specified by:

get­Parameter­Values in interface Single­Operation

Returns:

null.

getOperation

public SingleOperation 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 from Single­Operation to Coordinate­Operation. This change may be applied in GeoAPI 4.0. This is necessary for supporting usage of Pass­Through­Operation with Concatenated­Operation.

Specified by:

get­Operation in interface Pass­Through­Operation

Returns:

the operation to apply on the subset of a coordinate tuple.

See Also:

Pass­Through­Transform.get­Sub­Transform()

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:

get­Modified­Coordinates in interface Pass­Through­Operation

Returns:

zero-based indices of the modified source coordinates.

See Also:

Pass­Through­Transform.get­Modified­Coordinates()

equals

public boolean equals(Object object,
                      ComparisonMode mode)

Compares this concatenated operation with the specified object for equality. If the mode argument is Comparison­Mode.STRICT or BY_CONTRACT, then all available properties are compared including the domain of validity and the scope.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­Coordinate­Operation

Parameters:

object - the object to compare to this.

mode - STRICT for performing a strict comparison, or IGNORE_METADATA for ignoring properties that do not make a difference in the numerical results of coordinate operations.

Returns:

true if both objects are equal for the given comparison mode.

See Also:

Abstract­Identified­Object.compute­Hash­Code(), Utilities.deep­Equals(Object, Object, Comparison­Mode)

computeHashCode

protected long computeHashCode()

Invoked by hash­Code() for computing the hash code when first needed. See Abstract­Identified­Object.compute­Hash­Code() for more information.

Overrides:

compute­Hash­Code in class Abstract­Coordinate­Operation

Returns:

the hash code value. This value may change in any future Apache SIS version.

formatTo

protected String formatTo(Formatter formatter)

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:

format­To in class Abstract­Coordinate­Operation

Parameters:

formatter - the formatter to use.

Returns:

currently "Pass­Through­Operation" (may change in any future version).

Since:

0.7

See Also:

WKT 2 specification §17