Class Builder<B extends Builder<B>>
- Type Parameters:
B
- the builder subclass.
- Direct Known Subclasses:
GeodeticObjectBuilder
,ParameterBuilder
IdentifiedObject
. This class provides convenience methods
for filling the properties
map to be given to an ObjectFactory
.
The main properties are:
- Name:
eachIdentifiedObject
shall have a name, which can be specified by a call to any of theaddName(…)
methods defined in this class. - Aliases:
IdentifiedObject
s can optionally have an arbitrary number of aliases, which are also specified by theaddName(…)
methods. Each call after the first one adds an alias. - Identifiers:
IdentifiedObject
s can also have an arbitrary number of identifiers, which are specified by any of theaddIdentifier(…)
methods. Like names, more than one identifier can be added by invoking the method many time. - Code space:
IdentifiedObject
names and identifiers can be local to a code space defined by an authority. Both the authority and code space can be specified by thesetCodeSpace(Citation, String)
method, and usually (but not necessarily) apply to allIdentifier
instances. - Version:
Identifier
s can optionally have a version specified by thesetVersion(String)
method. The version usually (but not necessarily) applies to allIdentifier
instances. - Description:
Identifier
s can optionally have a description specified by thesetDescription(CharSequence)
method. The description applies only to the next identifier to create. - Remarks:
IdentifiedObject
s can have at most one remark, which is specified by thecode setRemarks(…)
method.
Namespaces and scopes
TheaddName(…)
and addIdentifier(…)
methods come in three flavors:
- The
addIdentifier(String)
andaddName(CharSequence)
methods combine the given argument with the above-cited authority, code space, version and description information. The result is a local name or identifier, in which the code space information is stored but not shown by thetoString()
method. - The
addIdentifier(Citation, String)
andaddName(Citation, CharSequence)
methods use the givenCitation
argument, ignoring any authority or code space information given to thisBuilder
. The result is a scoped name or identifier, in which the code space information is shown by thetoString()
method. - The
addIdentifier(Identifier)
,addName(Identifier)
andaddName(GenericName)
methods take the given object as-is. Any authority, code space, version or description information given to theBuilder
are ignored.
Mercator_1SP
" by OGC some specifications.
If we choose EPSG as our primary naming authority, then those three names can be declared as below:
The toString()
representation of those three names are "Mercator (variant A)"
,
"Mercator (1SP)"
(note the absence of "EPSG:"
prefix, which is stored as the
name scope but not shown) and
"OGC:Mercator_1SP"
respectively.Builder property lifetimes
Some complex objects require the creation of many components. For example, constructing a Coordinate Reference System (CRS) may require constructing a coordinate system, a datum and an ellipsoid among other components. However, all those components often (but not necessarily) share the same authority, code space and version information. In order to simplify that common usage, two groups of properties have different lifetimes in theBuilder
class:
-
Authority,
code space and
version:
Kept until they are specified again, because those properties are typically shared by all components. -
Name,
aliases,
identifiers,
description and
remarks:
Cleared after each call to acreateXXX(…)
method, because those properties are usually specific to a particularIdentifiedObject
orIdentifier
instance.
Usage examples
SeeParameterBuilder
class javadoc for more examples with the
Mercator projection parameters.
Note for subclass implementers
- The type
<B>
shall be exactly the subclass type. For performance reasons, this is verified only if Java assertions are enabled. - All
createXXX(…)
methods shall invokeonCreate(boolean)
before and after usage ofproperties
map by the factory.
- Since:
- 0.4
- Version:
- 1.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List<org.opengis.util.GenericName>
A temporary list for aliases, before to assign them to theproperties
.private final List<org.opengis.referencing.ReferenceIdentifier>
A temporary list for identifiers, before to assign them to theproperties
.private org.opengis.util.NameFactory
The name factory, fetched when first needed.private org.opengis.util.NameSpace
The codespace as aNameSpace
object, ornull
if not yet created.The properties to be given toObjectFactory
methods. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddIdentifier
(String identifier) Adds anIdentifiedObject
identifier given by aString
.addIdentifier
(org.opengis.metadata.citation.Citation authority, String identifier) Adds anIdentifiedObject
identifier in an alternative namespace.addIdentifier
(org.opengis.referencing.ReferenceIdentifier identifier) Adds anIdentifiedObject
identifier fully specified by the given identifier.addName
(CharSequence name) Adds anIdentifiedObject
name given by aString
orInternationalString
.addName
(org.opengis.metadata.citation.Citation authority, CharSequence name) Adds anIdentifiedObject
name in an alternative namespace.addName
(org.opengis.referencing.ReferenceIdentifier name) Adds anIdentifiedObject
name fully specified by the given identifier.addName
(org.opengis.util.GenericName name) Adds anIdentifiedObject
name fully specified by the given generic name.addNameAndIdentifier
(org.opengis.metadata.citation.Citation authority, org.opengis.referencing.IdentifiedObject object) Adds the non-deprecated names and identifiers from the given object for the specified authority.addNamesAndIdentifiers
(org.opengis.referencing.IdentifiedObject object) Adds all non-deprecated names and identifiers from the given object.private org.opengis.referencing.ReferenceIdentifier
createIdentifier
(org.opengis.metadata.citation.Citation authority, String identifier) Creates an identifier for the given authority.private org.opengis.referencing.ReferenceIdentifier
createIdentifier
(org.opengis.metadata.citation.Citation authority, String codeSpace, String identifier, String version) Creates an identifier for the given authority, code space and version.private org.opengis.util.GenericName
createName
(CharSequence name) Creates or returns an existing name for the given string in the current namespace.private org.opengis.util.GenericName
createName
(org.opengis.metadata.citation.Citation authority, CharSequence name) Creates or returns an existing name for the given string in the given namespace.private org.opengis.util.NameFactory
factory()
Returns the name factory to use for creating namespaces and local names.private org.opengis.metadata.citation.Citation
Returns the value of the first argument given by the last call tosetCodeSpace(Citation, String)
, ornull
if none.private String
Returns the value of the last argument given by the last call tosetCodeSpace(Citation, String)
, ornull
if none.private org.opengis.util.InternationalString
Returns the parameter description specified by the last call tosetDescription(CharSequence)
, ornull
if none.private org.opengis.util.InternationalString
Returns the remarks specified by the last call tosetRemarks(CharSequence)
, ornull
if none.private String
Returns the value given by the last call tosetVersion(String)
, ornull
if none.private boolean
Returnstrue
if the deprecated flag is set totrue
.private static boolean
Returnstrue
if the given name or identifier is non-null and non-deprecated.protected void
onCreate
(boolean cleanup) Initializes/cleanups theproperties
map before/after acreateXXX(…)
execution.reidentify
(org.opengis.metadata.citation.Citation authority, String... replacements) Replaces the identifiers associated to the given authority by the given new identifiers.rename
(org.opengis.metadata.citation.Citation authority, CharSequence... replacements) Replaces the names associated to the given authority by the given new names.private B
self()
Returnsthis
casted to<B>
.setCodeSpace
(org.opengis.metadata.citation.Citation authority, String codespace) Sets theIdentifier
authority and code space.setDeprecated
(boolean deprecated) Sets whether the nextGenericName
s,Identifier
s orIdentifiedObject
s to create shall be considered deprecated.setDescription
(CharSequence description) Sets anIdentifier
orIdentifiedObject
description.private boolean
setProperty
(String key, Object value) Sets the property value for the given key, if a change is still possible.setRemarks
(CharSequence remarks) Sets remarks as aString
orInternationalString
instance.setVersion
(String version) Sets theIdentifier
version of object definitions.private static org.opengis.referencing.ReferenceIdentifier
toIdentifier
(org.opengis.util.GenericName name) Converts the given name into an identifier.private static boolean
verifyParameterizedType
(Class<?> expected) Verifies thatB
in<B extends Builder<B>
is the expected class.
-
Field Details
-
properties
The properties to be given toObjectFactory
methods. This map may contain values for the "name", "alias", "identifiers" and "remarks" keys. Subclasses may add other entries like "domainOfValidity" and "scope" keys.See Notes for subclass implementers in class javadoc for usage conditions.
- See Also:
-
aliases
A temporary list for aliases, before to assign them to theproperties
. -
identifiers
A temporary list for identifiers, before to assign them to theproperties
. -
namespace
private transient org.opengis.util.NameSpace namespaceThe codespace as aNameSpace
object, ornull
if not yet created. This object is built from the "codespace" value when first needed. -
nameFactory
private transient org.opengis.util.NameFactory nameFactoryThe name factory, fetched when first needed.- See Also:
-
-
Constructor Details
-
Builder
protected Builder()Creates a new builder. -
Builder
protected Builder(org.opengis.referencing.IdentifiedObject object) Creates a new builder initialized to properties of the given object. The properties recognized by this constructor are documented here.- Parameters:
object
- the identified object from which to inherit properties, ornull
.- Since:
- 0.6
-
-
Method Details
-
verifyParameterizedType
Verifies thatB
in<B extends Builder<B>
is the expected class. This method is for assertion purposes only. -
self
Returnsthis
casted to<B>
. The cast is valid if the assertion performed at construction time passes. Since the<B>
type is hard-coded in the source code, if the JUnit test passes then the cast should always be valid for all instances of the same builder class. -
factory
private org.opengis.util.NameFactory factory()Returns the name factory to use for creating namespaces and local names. The factory will be fetched when first needed, and while not change anymore for the rest of thisBuilder
lifetime. -
createName
Creates or returns an existing name for the given string in the current namespace. The namespace may be cleared at anytime by a call tosetCodeSpace(Citation, String)
. -
createName
private org.opengis.util.GenericName createName(org.opengis.metadata.citation.Citation authority, CharSequence name) Creates or returns an existing name for the given string in the given namespace. -
createIdentifier
private org.opengis.referencing.ReferenceIdentifier createIdentifier(org.opengis.metadata.citation.Citation authority, String identifier) Creates an identifier for the given authority. If and only if the given authority is the default one, then the new identifier will also contain the user supplied code space and version (if any). The new identifier will be marked as deprecated ifisDeprecated()
returnstrue
. -
createIdentifier
private org.opengis.referencing.ReferenceIdentifier createIdentifier(org.opengis.metadata.citation.Citation authority, String codeSpace, String identifier, String version) Creates an identifier for the given authority, code space and version. The new identifier will be marked as deprecated ifisDeprecated()
returnstrue
. -
toIdentifier
private static org.opengis.referencing.ReferenceIdentifier toIdentifier(org.opengis.util.GenericName name) Converts the given name into an identifier. Note thatNamedIdentifier
implements bothGenericName
andIdentifier
interfaces. -
setProperty
Sets the property value for the given key, if a change is still possible. The check for change permission is needed for all keys defined in theIdentifier
interface. This check is not needed for other keys, so callers do not need to invoke this method for other keys.- Parameters:
key
- the key of the property to set.value
- the value to set.- Returns:
true
if the property changed as a result of this method call.- Throws:
IllegalStateException
- if a new value is specified in a phase where the value cannot be changed.
-
getAuthority
private org.opengis.metadata.citation.Citation getAuthority()Returns the value of the first argument given by the last call tosetCodeSpace(Citation, String)
, ornull
if none. The default value isnull
.- Returns:
- the citation specified by the last call to
setCodeSpace(…)
, ornull
if none. - Since:
- 0.6
-
getCodeSpace
Returns the value of the last argument given by the last call tosetCodeSpace(Citation, String)
, ornull
if none. The default value isnull
.- Returns:
- the string specified by the last call to
setCodeSpace(…)
, ornull
if none. - Since:
- 0.6
-
setCodeSpace
Sets theIdentifier
authority and code space. The code space is often the authority's abbreviation, but not necessarily.Example: Coordinate Reference System (CRS) objects identified by codes from the EPSG database are maintained by the International Association of Oil & Gas producers (IOGP) authority, but the code space isThis method is typically invoked only once, since a compound object often uses the same code space for all individual components."EPSG"
for historical reasons.Condition: this method cannot be invoked after one or more names or identifiers have been added (by calls to the
addName(…)
oraddIdentifier(…)
methods) for the next object to create. This method can be invoked again after the name, aliases and identifiers have been cleared by a call tocreateXXX(…)
.Lifetime: this property is kept unchanged until this
setCodeSpace(…)
method is invoked again.- Parameters:
authority
- bibliographic reference to the authority defining the codes, ornull
if none.codespace
- theIdentifiedObject
codespace, ornull
for inferring it from the authority.- Returns:
this
, for method call chaining.- Throws:
IllegalStateException
- ifaddName(…)
oraddIdentifier(…)
has been invoked at least once since builder construction or since the last call to acreateXXX(…)
method.- See Also:
-
getVersion
Returns the value given by the last call tosetVersion(String)
, ornull
if none. The default value isnull
.- Returns:
- the value specified by the last call to
setVersion(…)
, ornull
if none. - Since:
- 0.6
-
setVersion
Sets theIdentifier
version of object definitions. This method is typically invoked only once, since a compound object often uses the same version for all individual components.Condition: this method cannot be invoked after one or more names or identifiers have been added (by calls to the
addName(…)
oraddIdentifier(…)
methods) for the next object to create. This method can be invoked again after the name, aliases and identifiers have been cleared by a call tocreateXXX(…)
.Lifetime: this property is kept unchanged until this
setVersion(…)
method is invoked again.- Parameters:
version
- the version of code definitions, ornull
if none.- Returns:
this
, for method call chaining.- Throws:
IllegalStateException
- ifaddName(…)
oraddIdentifier(…)
has been invoked at least once since builder construction or since the last call to acreateXXX(…)
method.
-
addName
Adds anIdentifiedObject
name given by aString
orInternationalString
. The given string will be combined with the authority, code space and version information for creating theIdentifier
orGenericName
object.Name and aliases
This method can be invoked many times. The first invocation sets the primary name, and all subsequent invocations add an alias.Deprecated names
Some names may exist for historical reasons but have their use discouraged. IfsetDeprecated(true)
has been invoked, then this method creates a deprecated alias with the current remarks. The remark should suggest a replacement, for example with a sentence like "Superseded by <new-name>".Note that deprecated names are always added as aliases, never as the primary name of an identified object.
Lifetime: the name and all aliases are cleared after a
createXXX(…)
method has been invoked.- Parameters:
name
- theIdentifiedObject
name as aString
orInternationalString
instance.- Returns:
this
, for method call chaining.
-
addName
Adds anIdentifiedObject
name in an alternative namespace. This method is typically invoked for aliases defined after the primary name.Example: The "Longitude of natural origin" parameter defined by EPSG is named differently by OGC and GeoTIFF. Those alternative names can be defined as below: In this example,"central_meridian"
will be the tip and"OGC"
will be the head of the first alias.Lifetime: the name and all aliases are cleared after a
createXXX(…)
method has been invoked.- Parameters:
authority
- bibliographic reference to the authority defining the codes, ornull
if none.name
- theIdentifiedObject
alias as a name in the namespace of the given authority.- Returns:
this
, for method call chaining.- See Also:
-
addName
Adds anIdentifiedObject
name fully specified by the given identifier. This method ignores the authority, code space, version and description specified to this builder (if any), since the given identifier may already contain those information.Name and aliases
This method can be invoked many times. The first invocation sets the primary name to the given value, and all subsequent invocations add an alias.Lifetime: the name and all aliases are cleared after a
createXXX(…)
method has been invoked.- Parameters:
name
- theIdentifiedObject
name as an identifier.- Returns:
this
, for method call chaining.
-
addName
Adds anIdentifiedObject
name fully specified by the given generic name. This method ignores the authority, code space, version and description specified to this builder (if any), since the given generic name may already contain those information.Name and aliases
This method can be invoked many times. The first invocation sets the primary name to the given value, and all subsequent invocations add an alias.Lifetime: the name and all aliases are cleared after a
createXXX(…)
method has been invoked.- Parameters:
name
- theIdentifiedObject
name as an identifier.- Returns:
this
, for method call chaining.
-
addIdentifier
Adds anIdentifiedObject
identifier given by aString
. The given string will be combined with the authority, code space version and description information for creating theIdentifier
object.Deprecated identifiers
Some identifiers may exist for historical reasons but have their use discouraged. IfsetDeprecated(true)
has been invoked, then this method creates a deprecated identifier with the current remarks. The remark should suggest a replacement, for example with a sentence like "Superseded by <new-code>".Lifetime: all identifiers are cleared after a
createXXX(…)
method has been invoked.- Parameters:
identifier
- theIdentifiedObject
identifier.- Returns:
this
, for method call chaining.
-
addIdentifier
Adds anIdentifiedObject
identifier in an alternative namespace. This method is typically invoked in complement toaddName(Citation, CharSequence)
.Lifetime: all identifiers are cleared after a
createXXX(…)
method has been invoked.- Parameters:
authority
- bibliographic reference to the authority defining the codes, ornull
if none.identifier
- theIdentifiedObject
identifier as a code in the namespace of the given authority.- Returns:
this
, for method call chaining.- See Also:
-
addIdentifier
Adds anIdentifiedObject
identifier fully specified by the given identifier. This method ignores the authority, code space, version and description specified to this builder (if any), since the given identifier already contains those information.Lifetime: all identifiers are cleared after a
createXXX(…)
method has been invoked.- Parameters:
identifier
- theIdentifiedObject
identifier.- Returns:
this
, for method call chaining.
-
isValid
Returnstrue
if the given name or identifier is non-null and non-deprecated.- See Also:
-
addNamesAndIdentifiers
Adds all non-deprecated names and identifiers from the given object. Other properties like description and remarks are ignored.This is a convenience method for using an existing object as a template, before to modify some names by calls to
rename(Citation, CharSequence[])
.- Parameters:
object
- the object from which to copy the names and identifiers.- Returns:
this
, for method call chaining.- Since:
- 0.6
-
addNameAndIdentifier
public B addNameAndIdentifier(org.opengis.metadata.citation.Citation authority, org.opengis.referencing.IdentifiedObject object) Adds the non-deprecated names and identifiers from the given object for the specified authority. This is a convenience method for reusing name and identifier already declared for another object.- Parameters:
authority
- the authority for which to copy the name and identifier.object
- the object from which to copy the name and identifier.- Returns:
this
, for method call chaining.- Since:
- 1.1
-
rename
Replaces the names associated to the given authority by the given new names. More specifically:- The first occurrence of a name associated to
authority
will be replaced by a new name with the same authority and the local part defined byreplacements[0]
. - The second occurrence of a name associated to
authority
will be replaced by a new name with the same authority and the local part defined byreplacements[1]
. - etc. until one of the following conditions is met:
- There are no more names associated to the given authority in this
Builder
, in which case new names are inserted for all remaining elements in thereplacements
array. - There are no more elements in the
replacements
array, in which case all remaining names associated to the given authority in thisBuilder
are removed.
- There are no more names associated to the given authority in this
setNames(Citation, ...)
method, except that it modifies only the names associated to the given authority and preserves the same order than previous names.- Parameters:
authority
- the authority of the names to replaces.replacements
- the new local parts for the names to replace, ornull
or an empty array for removing all names associated to the given authority.- Returns:
this
, for method call chaining.- Since:
- 0.6
- The first occurrence of a name associated to
-
reidentify
Replaces the identifiers associated to the given authority by the given new identifiers. More specifically:- The first occurrence of an identifier associated to
authority
will be replaced by a new identifier with the same authority and the code defined byreplacements[0]
. - The second occurrence of an identifier associated to
authority
will be replaced by a new identifier with the same authority and the local part defined byreplacements[1]
. - etc. until one of the following conditions is met:
- There are no more identifiers associated to the given authority in this
Builder
, in which case new identifiers are inserted for all remaining elements in thereplacements
array. - There are no more elements in the
replacements
array, in which case all remaining identifiers associated to the given authority in thisBuilder
are removed.
- There are no more identifiers associated to the given authority in this
setIdentifiers(Citation, ...)
method, except that it modifies only the identifiers associated to the given authority and preserves the same order than previous identifiers.- Parameters:
authority
- the authority of the names to replaces.replacements
- the new local parts for the names to replace, ornull
or an empty array for removing all names associated to the given authority.- Returns:
this
, for method call chaining.- Since:
- 0.8
- The first occurrence of an identifier associated to
-
getDescription
private org.opengis.util.InternationalString getDescription()Returns the parameter description specified by the last call tosetDescription(CharSequence)
, ornull
if none. -
setDescription
Sets anIdentifier
orIdentifiedObject
description. Descriptions can be used in various contexts:- Before calls to
addIdentifier(String)
oraddIdentifier(Citation, String)
for specifying a natural language description of the meaning of the code value.Example:setDescription("World Geodetic System 1984").addIdentifier("4326")
- Before calls to a
createXXX(…)
method for providing a narrative explanation of the role of the object. Not allIdentifiedObject
supports description.
Lifetime: previous descriptions are discarded by calls to
setDescription(…)
. Descriptions are cleared after acreateXXX(…)
method has been invoked.- Parameters:
description
- the description as aString
orInternationalString
instance, ornull
if none.- Returns:
this
, for method call chaining.- See Also:
- Before calls to
-
getRemarks
private org.opengis.util.InternationalString getRemarks()Returns the remarks specified by the last call tosetRemarks(CharSequence)
, ornull
if none. -
setRemarks
Sets remarks as aString
orInternationalString
instance. Calls to this method overwrite any previous value.Lifetime: previous remarks are discarded by calls to
setRemarks(…)
. Remarks are cleared after acreateXXX(…)
method has been invoked.- Parameters:
remarks
- the remarks as aString
orInternationalString
instance, ornull
if none.- Returns:
this
, for method call chaining.
-
isDeprecated
private boolean isDeprecated()Returnstrue
if the deprecated flag is set totrue
. -
setDeprecated
Sets whether the nextGenericName
s,Identifier
s orIdentifiedObject
s to create shall be considered deprecated. Deprecated objects exist in some authority factories like the EPSG database.Lifetime: Deprecation status is cleared after a
createXXX(…)
method has been invoked.- Parameters:
deprecated
-true
if the next names, identifiers and identified objects should be considered deprecated, orfalse
otherwise.- Returns:
this
, for method call chaining.- Since:
- 0.6
- See Also:
-
onCreate
protected void onCreate(boolean cleanup) Initializes/cleanups theproperties
map before/after acreateXXX(…)
execution. Subclasses shall invoke this method in theircreateXXX(…)
methods as below: Ifcleanup
istrue
, then this method clears the identification information (name, aliases, identifiers, description, remarks and deprecation status) for preparing the builder to the construction of another object. The authority, codespace and version properties are not cleared by this method.- Parameters:
cleanup
-false
when this method is invoked before object creation, andtrue
when this method is invoked after object creation.- See Also:
-