Module org.opengis.geoapi

Package org.opengis.referencing.operation

Interface Formula

@Classifier(UNION)
@UML(identifier="CC_Formula",
     specification=ISO_19111)
public interface Formula

Specification of the coordinate operation method formula. A formula may be given textually, or may be a reference to a publication. If the operation method is not analytic, then Formula actually gives the procedure rather than an analytic formula.

Formulas are given by OperationMethod.getFormula(). Formula objects are for human reading; the object that actually does the work of applying the formula or procedure to coordinate values is MathTransform.

Since:

2.3

See Also:

• MathTransform
• OperationMethod.getFormula()

Method Summary

Modifier and Type	Method	Description
Citation	getCitation()	Reference to a publication giving the formula(s) or procedure used by the coordinate operation method.
InternationalString	getFormula()	Formula(s) or procedure used by the operation method.

Method Details

getFormula

@UML(identifier="formula",
     obligation=CONDITIONAL,
     specification=ISO_19111)
InternationalString getFormula()

Formula(s) or procedure used by the operation method. Only one of getFormula() and getCitation() should be supplied.

Returns:

the formula used by the operation method, or null if none.

getCitation

@UML(identifier="formulaCitation",
     obligation=CONDITIONAL,
     specification=ISO_19111)
Citation getCitation()

Reference to a publication giving the formula(s) or procedure used by the coordinate operation method. Only one of getFormula() and getCitation() should be supplied.

Returns:

reference to a publication giving the formula, or null if none.