Class DefaultPassThroughOperation

Object

FormattableObject

AbstractIdentifiedObject

AbstractCoordinateOperation

DefaultPassThroughOperation

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Identified­Object, Coordinate­Operation, Pass­Through­Operation, Single­Operation

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

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface CoordinateOperation

COORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	COORDINATE_OPERATION_ACCURACY_KEY	Key for the "coordinate­Operation­Accuracy" property.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property.
static final String	OPERATION_VERSION_KEY	Key for the "operation­Version" property.
static final String	SCOPE_KEY	Key for the "scope" property.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Pass­Through­Operation(Map<String,?> properties, Coordinate­Reference­System source­CRS, Coordinate­Reference­System target­CRS, Single­Operation operation, int first­Affected­Coordinate, int num­Trailing­Coordinates)	Constructs a pass-through operation from a set of properties.
protected	Default­Pass­Through­Operation(Pass­Through­Operation operation)	Creates a new coordinate operation with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Pass­Through­Operation	cast­Or­Copy(Pass­Through­Operation object)	Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this coordinate operation in a pseudo-Well Known Text (WKT) format.
Operation­Method	get­Method()	Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.
int[]	get­Modified­Coordinates()	Returns the ordered sequence of indices in a source coordinate tuple of the coordinates affected by this pass-through operation.
Single­Operation	get­Operation()	Returns the operation to apply on the subset of a coordinate tuple.
Parameter­Value­Group	get­Parameter­Values()	Deprecated. May be removed in GeoAPI 4.0 since it does not apply to pass-through operations.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

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­Source­Epoch, get­Target­CRS, get­Target­Epoch, get­Wrap­Around­Changes, is­Defining­Conversion, transform

Modifier and Type	Method	Description
static Abstract­Coordinate­Operation	cast­Or­Copy(Coordinate­Operation object)	Returns a SIS coordinate operation implementation with the values of the given arbitrary implementation.
Collection<Positional­Accuracy>	get­Coordinate­Operation­Accuracy()	Returns an estimation of the impact of this operation on point accuracy.
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Optional<Coordinate­Reference­System>	get­Interpolation­CRS()	Returns the CRS to be used for interpolations in a grid.
double	get­Linear­Accuracy()	Returns an estimation of positional accuracy in metres, or Na­N if unknown.
Math­Transform	get­Math­Transform()	Returns the object for transforming coordinates in the source CRS to coordinates in the target CRS.
String	get­Operation­Version()	Returns the version of the coordinate operation.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Coordinate­Reference­System	get­Source­CRS()	Returns the source CRS, or null if unspecified.
Optional<Temporal>	get­Source­Epoch()	Returns the date at which source coordinate tuples are valid.
Coordinate­Reference­System	get­Target­CRS()	Returns the target CRS, or null if unspecified.
Optional<Temporal>	get­Target­Epoch()	Returns the date at which target coordinate tuples are valid.
Set<Integer>	get­Wrap­Around­Changes()	Returns the indices of target dimensions where "wrap around" may happen as a result of this coordinate operation.
boolean	is­Defining­Conversion()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by the Defining­Conversion class.
Abstract­Coordinate­Set	transform(Abstract­Coordinate­Set data)	Changes coordinates from being referenced to the source CRS and/or epoch to being referenced to the target CRS and/or epoch.

Methods inherited from class AbstractIdentifiedObject

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

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

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 as 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­Coordinate - index of the first affected coordinate.

num­Trailing­Coordinates - number of trailing coordinates to pass through.

DefaultPassThroughOperation

protected DefaultPassThroughOperation(PassThroughOperation operation)

Creates a new coordinate operation with the same values as 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 Details

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, because 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.

getStandardType

public Type getStandardType()

Returns the GeoAPI interface that defines the contract of this implementation class. This is the base type required by equals(…) methods for returning a potentially true value.

Specified by:

get­Standard­Type in interface Lenient­Comparable

Overrides:

get­Standard­Type in class Abstract­Coordinate­Operation

Returns:

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

Since:

1.7

See Also:

• Comparison­Mode.BY_CONTRACT
• Classes.get­Raw­Class(Type)
• Classes.get­Standard­Class(Object, Class)

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 interface: Single­Operation

Returns the operation method.

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 interface: Single­Operation

Returns the parameter values.

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()

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:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()