Module org.apache.sis.feature

Package org.apache.sis.feature.builder

Class CharacteristicTypeBuilder<V>

Object

TypeBuilder

CharacteristicTypeBuilder<V>

Type Parameters:

V - the class of characteristic values.

All Implemented Interfaces:

Localized

public final class CharacteristicTypeBuilder<V>
extends TypeBuilder

Describes one characteristic of the Attribute­Type will will be built by a Feature­Type­Builder. Characteristics can describe additional information useful for interpreting an attribute value, like the units of measurement and uncertainties of a numerical value, or the coordinate reference system (CRS) of a geometry.

In many cases, all instances of the same Attribute­Type have the same characteristics. For example, all values of the "temperature" attribute typically have the same units of measurement. Such common value can be specified as the characteristic default value.

Since:

0.8

See Also:

• Attribute­Type­Builder.add­Characteristic(Class)

Method Summary

Modifier and Type	Method	Description
Default­Attribute­Type<V>	build()	Builds the characteristic type from the information specified to this builder.
V	get­Default­Value()	Returns the default value for the characteristic, or null if none.
Class<V>	get­Value­Class()	Returns the class of characteristic values.
void	remove()	Removes this characteristics from the Attribute­Type­Builder.
Characteristic­Type­Builder<V>	set­Default­Value(V value)	Sets the default value for the characteristic.
Characteristic­Type­Builder<V>	set­Definition(Char­Sequence definition)	Sets a concise definition of the element.
Characteristic­Type­Builder<V>	set­Deprecated(boolean deprecated)	Sets whether the type is deprecated.
Characteristic­Type­Builder<V>	set­Description(Char­Sequence description)	Sets optional information beyond that required for concise definition of the element.
Characteristic­Type­Builder<V>	set­Designation(Char­Sequence designation)	Sets a natural language designator for the element.
Characteristic­Type­Builder<V>	set­Name(Char­Sequence local­Part)	Sets the characteristic name as a simple string (local name).
Characteristic­Type­Builder<V>	set­Name(Char­Sequence... components)	Sets the characteristic name as a string in the given scope.
Characteristic­Type­Builder<V>	set­Name(Generic­Name name)	Sets the characteristic name as a generic name.
<N> Characteristic­Type­Builder<N>	set­Value­Class(Class<N> type)	Sets the class of characteristic values.

Methods inherited from class TypeBuilder

get­Definition, get­Description, get­Designation, get­Locale, get­Name, is­Deprecated, to­String

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Method Details

setName

public CharacteristicTypeBuilder<V> setName(GenericName name)

Sets the characteristic name as a generic name. If another name was defined before this method call, that previous value will be discarded.

Overrides:

set­Name in class Type­Builder

Parameters:

name - the generic name (cannot be null).

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Name()
• Type­Builder.set­Name(Char­Sequence)
• Abstract­Identified­Type.NAME_KEY

setName

public CharacteristicTypeBuilder<V> setName(CharSequence localPart)

Sets the characteristic name as a simple string (local name). The namespace will be the value specified by the last call to Feature­Type­Builder.set­Name­Space(Char­Sequence), but that namespace will not be visible in the string representation unless the fully qualified name is requested.

This convenience method creates a Local­Name instance from the given Char­Sequence, then delegates to set­Name(Generic­Name).

Overrides:

set­Name in class Type­Builder

Parameters:

local­Part - the local part of the generic name as a String or International­String.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Name()
• Type­Builder.set­Name(Char­Sequence...)
• Feature­Type­Builder.get­Name­Space()

setName

public CharacteristicTypeBuilder<V> setName(CharSequence... components)

Sets the characteristic name as a string in the given scope. The components array must contain at least one element. The last component (the tip) will be sufficient in many cases for getting values from the characteristics map. The other elements before the last one are optional and can be used for resolving ambiguity. They will be visible as the name path.

In addition to the path specified by the components array, the name may also contain a namespace specified by the last call to Feature­Type­Builder.set­Name­Space(Char­Sequence). But contrarily to the specified components, the namespace will not be visible in the name string representation unless the fully qualified name is requested.

This convenience method creates a Local­Name or Scoped­Name instance depending on whether the names array contains exactly 1 element or more than 1 element, then delegates to set­Name(Generic­Name).

Overrides:

set­Name in class Type­Builder

Parameters:

components - the name components as an array of String or International­String instances.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Name()
• Type­Builder.set­Name(Char­Sequence)
• Feature­Type­Builder.get­Name­Space()

getValueClass

public Class<V> getValueClass()

Returns the class of characteristic values.

Returns:

the class of characteristic values.

See Also:

• set­Value­Class(Class)

setValueClass

public <N> CharacteristicTypeBuilder<N> setValueClass(Class<N> type)
                                               throws UnconvertibleObjectException

Sets the class of characteristic values. Callers must use the builder returned by this method instead of this builder after this method call, since the returned builder may be a new instance.

Type Parameters:

N - the compile-time value of the type argument.

Parameters:

type - the new class of characteristic values.

Returns:

the characteristic builder — not necessarily this instance.

Throws:

Unconvertible­Object­Exception - if the default value cannot be converted to the given <N> class.

See Also:

• get­Value­Class()

getDefaultValue

public V getDefaultValue()

Returns the default value for the characteristic, or null if none.

Returns:

the default characteristic value, or null if none.

See Also:

• set­Default­Value(Object)

setDefaultValue

public CharacteristicTypeBuilder<V> setDefaultValue(V value)

Sets the default value for the characteristic.

Parameters:

value - characteristic default value, or null if none.

Returns:

this for allowing method calls chaining.

See Also:

• get­Default­Value()

setDefinition

public CharacteristicTypeBuilder<V> setDefinition(CharSequence definition)

Sets a concise definition of the element.

Overrides:

set­Definition in class Type­Builder

Parameters:

definition - a concise definition of the element, or null if none.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Definition()
• Abstract­Identified­Type.DEFINITION_KEY

setDesignation

public CharacteristicTypeBuilder<V> setDesignation(CharSequence designation)

Sets a natural language designator for the element. This can be used as an alternative to the name in user interfaces.

Overrides:

set­Designation in class Type­Builder

Parameters:

designation - a natural language designator for the element, or null if none.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Designation()
• Abstract­Identified­Type.DESIGNATION_KEY

setDescription

public CharacteristicTypeBuilder<V> setDescription(CharSequence description)

Sets optional information beyond that required for concise definition of the element. The description may assist in understanding the feature scope and application. If the type is deprecated, then the description should give indication about the replacement (e.g. "superceded by …").

Overrides:

set­Description in class Type­Builder

Parameters:

description - information beyond that required for concise definition of the element, or null if none.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.get­Description()
• Abstract­Identified­Type.DESCRIPTION_KEY

setDeprecated

public CharacteristicTypeBuilder<V> setDeprecated(boolean deprecated)

Sets whether the type is deprecated. If the type is deprecated, then the description should be set to an indication about the replacement (e.g. "superceded by …").

Overrides:

set­Deprecated in class Type­Builder

Parameters:

deprecated - whether this type is deprecated.

Returns:

this for allowing method calls chaining.

See Also:

• Type­Builder.is­Deprecated()
• Abstract­Identified­Type.DEPRECATED_KEY

build

public DefaultAttributeType<V> build()

Builds the characteristic type from the information specified to this builder. If a type has already been built and this builder state has not changed since the type creation, then the previously created Attribute­Type instance is returned.

Warning: In a future SIS version, the return type may be changed to the org.opengis.feature.Attribute­Type interface. This change is pending GeoAPI revision.

Specified by:

build in class Type­Builder

Returns:

the characteristic type.

remove

public void remove()

Removes this characteristics from the Attribute­Type­Builder. After this method has been invoked, this Characteristic­Type­Builder instance is no longer in the list returned by Attribute­Type­Builder.characteristics() and attempts to invoke any setter method on this will cause an Illegal­State­Exception to be thrown.