Class DefaultFormula
Object
FormattableObject
DefaultFormula
- All Implemented Interfaces:
- Serializable,- Formula
Specification of the coordinate operation method formula.
 A formula may be given textually,
 or may be a reference to a publication.
 
Formula is for human reading.
 The object that actually does the work of applying formula to coordinate values is
 MathTransform.
- Since:
- 0.5
- See Also:
Defined in the sis-referencing module
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultFormula(CharSequence formula) Creates a new formula from the given string.DefaultFormula(Citation citation) Creates a new formula from the given citation.protectedDefaultFormula(Formula formula) Creates a new formula with the same values than the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultFormulacastOrCopy(Formula object) Returns a SIS formula implementation with the same values than the given arbitrary implementation.booleanCompares this formula with the given object for equality.protected StringFormats this formula as a pseudo-Well Known Text element.Returns the reference to a publication giving the formula(s) or procedure used by the coordinate operation method, ornullif none.Returns the formula(s) or procedure used by the operation method, ornullif none.intReturns a hash code value for this formula.Methods inherited from class FormattableObjectprint, toString, toString, toWKT
- 
Constructor Details- 
DefaultFormulaCreates a new formula from the given string.- Parameters:
- formula- the formula.
 
- 
DefaultFormulaCreates a new formula from the given citation.- Parameters:
- citation- the citation.
 
- 
DefaultFormulaCreates a new formula 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:
- formula- the formula to copy.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns a SIS formula implementation with the same values than the given arbitrary implementation. If the given object isnull, then this method returnsnull. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- Parameters:
- object- the object to get as a SIS implementation, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- 
getFormulaReturns the formula(s) or procedure used by the operation method, ornullif none.- Specified by:
- getFormulain interface- Formula
 
- 
getCitationReturns the reference to a publication giving the formula(s) or procedure used by the coordinate operation method, ornullif none.- Specified by:
- getCitationin interface- Formula
 
- 
hashCodepublic int hashCode()Returns a hash code value for this formula.
- 
equalsCompares this formula with the given object for equality.
- 
formatToFormats this formula as a pseudo-Well Known Text element.Compatibility note: ISO 19162 does not define a WKT representation forFormulaobjects. The text formatted by this method is SIS-specific and causes the text to be flagged as invalid WKT. The WKT content of this element may change in any future SIS version.- Specified by:
- formatToin class- FormattableObject
- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "Formula".
- See Also:
 
 
-