DefaultRepresentativeFraction (Apache SIS 1.6 API)
JavaScript is disabled on your browser.
   
Skip navigation links
Overview
Class
Use
Tree
New
Deprecated
Index
Search
Help
org.apache.sis.metadata
org.apache.sis.metadata.iso.identification
DefaultRepresentativeFraction
Contents 
Description
Limitations
Constructor Summary
Method Summary
Constructor Details
DefaultRepresentativeFraction()
DefaultRepresentativeFraction(long)
DefaultRepresentativeFraction(RepresentativeFraction)
Method Details
castOrCopy(RepresentativeFraction)
getDenominator()
setDenominator(long)
setScale(double)
doubleValue()
floatValue()
longValue()
intValue()
isEmpty()
freeze()
clone()
equals(Object)
hashCode()
toString()
getIdentifiers()
getIdentifierMap()
Hide sidebar  Show sidebar
Class DefaultRepresentativeFraction
Object
Number
DefaultRepresentativeFraction
All Implemented Interfaces:
Serializable, Cloneable, Emptiable, Identified­Object, Representative­Fraction
public class DefaultRepresentativeFraction
extends Number
implements RepresentativeFraction, IdentifiedObject, Emptiable, Cloneable
A scale defined as the inverse of a denominator.
Scale is defined as a kind of Number.
The following property is mandatory in a well-formed metadata according ISO 19115:
MD_Representative­Fraction
└─denominator………………………… The number below the line in a vulgar fraction.
In addition to the standard properties, SIS provides the following methods:
set­Scale(double) for computing the denominator from a scale value.
Limitations
Instances of this class are not synchronized for multi-threading.
Synchronization, if needed, is caller's responsibility.
Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
See Also:
Default­Resolution​.get­Equivalent­Scale()
Serialized Form
Constructor Summary
Constructors
Constructor
Description
Default­Representative­Fraction()
Creates a uninitialized representative fraction.
Default­Representative­Fraction(long denominator)
Creates a new representative fraction from the specified denominator.
Default­Representative­Fraction(Representative­Fraction object)
Constructs a new representative fraction initialized to the value of the given object.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
static Default­Representative­Fraction
cast­Or­Copy(Representative­Fraction object)
Returns a SIS metadata implementation with the same values as the given arbitrary
implementation.
Default­Representative­Fraction
clone()
Returns a modifiable copy of this representative fraction.
double
double­Value()
Returns the scale value of this representative fraction.
boolean
equals(Object object)
Compares this object with the specified value for equality.
float
float­Value()
Returns the scale as a float type.
void
freeze()
Makes this representative fraction unmodifiable.
long
get­Denominator()
Returns the denominator of this representative fraction.
Identifier­Map
get­Identifier­Map()
Returns a map view of the identifiers collection as (authority,
code) entries.
Collection<Identifier>
get­Identifiers()
Returns all identifiers associated to this object, or an empty collection if none.
int
hash­Code()
Returns a hash value for this representative fraction.
int
int­Value()
Returns 1 if the denominator is equal to 1, or 0 otherwise.
boolean
is­Empty()
Returns true if no scale is defined.
long
long­Value()
Returns 1 if the denominator is equal to 1, or 0 otherwise.
void
set­Denominator(long denominator)
Sets the denominator value.
void
set­Scale(double scale)
Sets the denominator from a scale in the (0 … 1] range.
String
to­String()
Returns a string representation of this scale, or Na­N if undefined.
Methods inherited from class Number
byte­Value, short­Value
Methods inherited from class Object
finalize, get­Class, notify, notify­All, wait, wait, wait
Constructor Details
DefaultRepresentativeFraction
public DefaultRepresentativeFraction()
Creates a uninitialized representative fraction.
The denominator is initially zero
and the double value is NaN.
DefaultRepresentativeFraction
public DefaultRepresentativeFraction(long denominator)
Creates a new representative fraction from the specified denominator.
Parameters:
denominator - the denominator as a positive number, or 0 if unspecified.
Throws:
Illegal­Argument­Exception - if the given value is negative.
DefaultRepresentativeFraction
public DefaultRepresentativeFraction(RepresentativeFraction object)
Constructs a new representative fraction initialized to the value of the given object.
Note on properties validation
This constructor does not verify the property values of the given metadata (e.g. whether it contains
unexpected negative values). This is because invalid metadata exist in practice, and verifying their
validity in this copy constructor is often too late. Note that this is not the only hole, as invalid
metadata instances can also be obtained by unmarshalling an invalid XML document.
Parameters:
object - the metadata to copy values from, or null if none.
Method Details
castOrCopy
public static DefaultRepresentativeFraction castOrCopy(RepresentativeFraction object)
Returns a SIS metadata implementation with the same values as the given arbitrary
implementation. If the given object is null, then this method returns null.
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
property values of the given object, using a shallow copy operation
(i.e. properties are not cloned).
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.
getDenominator
@ValueRange(minimum=0.0)
public long getDenominator()
Returns the denominator of this representative fraction.
Specified by:
get­Denominator in interface Representative­Fraction
Returns:
the denominator.
setDenominator
public void setDenominator(long denominator)
Sets the denominator value.
Parameters:
denominator - the new denominator value, or 0 if none.
Throws:
Illegal­Argument­Exception - if the given value is negative.
setScale
public void setScale(double scale)
Sets the denominator from a scale in the (0 … 1] range.
The denominator is computed by round(1 / scale).
The equivalent of a get­Scale() method is double­Value().
Parameters:
scale - the scale as a number between 0 exclusive and 1 inclusive, or NaN.
Throws:
Illegal­Argument­Exception - if the given scale is our of range.
doubleValue
public double doubleValue()
Returns the scale value of this representative fraction.
This method is the converse of set­Scale(double).
Specified by:
double­Value in interface Representative­Fraction
Specified by:
double­Value in class Number
Returns:
the scale value of this representative fraction, or NaN if none.
floatValue
public float floatValue()
Returns the scale as a float type.
Specified by:
float­Value in class Number
Returns:
the scale.
longValue
public long longValue()
Returns 1 if the denominator is equal to 1, or 0 otherwise.
This method is implemented that way because scales smaller than 1 can only be cast to 0,
and NaN values are also represented by 0.
Specified by:
long­Value in class Number
Returns:
1 if the denominator is 1, or 0 otherwise.
intValue
public int intValue()
Returns 1 if the denominator is equal to 1, or 0 otherwise.
This method is implemented that way because scales smaller than 1 can only be cast to 0,
and NaN values are also represented by 0.
Specified by:
int­Value in class Number
Returns:
1 if the denominator is 1, or 0 otherwise.
isEmpty
public boolean isEmpty()
Returns true if no scale is defined.
The following relationship shall hold:
Copy
assert isEmpty() == Double.isNaN(doubleValue());
Specified by:
is­Empty in interface Emptiable
Returns:
true if no scale is defined.
Since:
0.6
See Also:
double­Value()
float­Value()
freeze
public void freeze()
Makes this representative fraction unmodifiable. After invocation to this method,
any call to a setter method will throw an Unmodifiable­Metadata­Exception.
Since:
0.7
See Also:
Modifiable­Metadata​.transition­To(Modifiable­Metadata​.State)
clone
public DefaultRepresentativeFraction clone()
Returns a modifiable copy of this representative fraction.
Overrides:
clone in class Object
Returns:
a modifiable copy of this representative fraction.
equals
public boolean equals(Object object)
Compares this object with the specified value for equality.
Specified by:
equals in interface Representative­Fraction
Overrides:
equals in class Object
Parameters:
object - the object to compare with.
Returns:
true if both objects are equal.
hashCode
public int hashCode()
Returns a hash value for this representative fraction.
Specified by:
hash­Code in interface Representative­Fraction
Overrides:
hash­Code in class Object
Returns:
A hash code value for this representative fraction.
toString
public String toString()
Returns a string representation of this scale, or Na­N if undefined.
If defined, the string representation uses the colon as in "1:20000".
Overrides:
to­String in class Object
Returns:
a string representation of this scale.
getIdentifiers
public Collection<Identifier> getIdentifiers()
Returns all identifiers associated to this object, or an empty collection if none.
Those identifiers are marshalled in XML as id or uuid attributes.
Specified by:
get­Identifiers in interface Identified­Object
Returns:
all identifiers associated to this object, or an empty collection if none.
See Also:
Default­Citation​.get­Identifiers()
Default­Objective​.get­Identifiers()
Abstract­Identified­Object​.get­Identifiers()
getIdentifierMap
public IdentifierMap getIdentifierMap()
Returns a map view of the identifiers collection as (authority,
code) entries. That map is live: changes in the identifiers list will be reflected
in the map, and conversely.
Specified by:
get­Identifier­Map in interface Identified­Object
Returns:
the identifiers as a map of (authority, code) entries,
or an empty map if none.