Class CharacteristicTypeBuilder<V>
- Type Parameters:
- V- the class of characteristic values.
- All Implemented Interfaces:
- Localized
AttributeType will will be built by a FeatureTypeBuilder.
 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 AttributeType 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:
Defined in the sis-feature module
- 
Method SummaryModifier and TypeMethodDescriptionbuild()Builds the characteristic type from the information specified to this builder.Returns the default value for the characteristic, ornullif none.Returns the class of characteristic values.voidremove()Removes this characteristics from theAttributeTypeBuilder.setDefaultValue(V value) Sets the default value for the characteristic.setDefinition(CharSequence definition) Sets a concise definition of the element.setDeprecated(boolean deprecated) Sets whether the type is deprecated.setDescription(CharSequence description) Sets optional information beyond that required for concise definition of the element.setDesignation(CharSequence designation) Sets a natural language designator for the element.setName(CharSequence localPart) Sets the characteristic name as a simple string (local name).setName(CharSequence... components) Sets the characteristic name as a string in the given scope.setName(GenericName name) Sets the characteristic name as a generic name.<N> CharacteristicTypeBuilder<N>setValueClass(Class<N> type) Sets the class of characteristic values.Methods inherited from class TypeBuildergetDefinition, getDescription, getDesignation, getLocale, getName, isDeprecated, toString
- 
Method Details- 
setNameSets the characteristic name as a generic name. If another name was defined before this method call, that previous value will be discarded.- Overrides:
- setNamein class- TypeBuilder
- Parameters:
- name- the generic name (cannot be- null).
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setNameSets the characteristic name as a simple string (local name). The namespace will be the value specified by the last call toFeatureTypeBuilder.setNameSpace(CharSequence), but that namespace will not be visible in the string representation unless the fully qualified name is requested.This convenience method creates a LocalNameinstance from the givenCharSequence, then delegates tosetName(GenericName).- Overrides:
- setNamein class- TypeBuilder
- Parameters:
- localPart- the local part of the generic name as a- Stringor- InternationalString.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setNameSets the characteristic name as a string in the given scope. Thecomponentsarray 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 componentsarray, the name may also contain a namespace specified by the last call toFeatureTypeBuilder.setNameSpace(CharSequence). 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 LocalNameorScopedNameinstance depending on whether thenamesarray contains exactly 1 element or more than 1 element, then delegates tosetName(GenericName).- Overrides:
- setNamein class- TypeBuilder
- Parameters:
- components- the name components as an array of- Stringor- InternationalStringinstances.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
getValueClassReturns the class of characteristic values.- Returns:
- the class of characteristic values.
- See Also:
 
- 
setValueClasspublic <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 ofthisbuilder after this method call, since the returned builder may be a new instance.- Type Parameters:
- N- the compile-time value of the- typeargument.
- Parameters:
- type- the new class of characteristic values.
- Returns:
- the characteristic builder — not necessarily this instance.
- Throws:
- UnconvertibleObjectException- if the default value cannot be converted to the given- <N>class.
- See Also:
 
- 
getDefaultValueReturns the default value for the characteristic, ornullif none.- Returns:
- the default characteristic value, or nullif none.
- See Also:
 
- 
setDefaultValueSets the default value for the characteristic.- Parameters:
- value- characteristic default value, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDefinitionSets a concise definition of the element.- Overrides:
- setDefinitionin class- TypeBuilder
- Parameters:
- definition- a concise definition of the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDesignationSets a natural language designator for the element. This can be used as an alternative to the name in user interfaces.- Overrides:
- setDesignationin class- TypeBuilder
- Parameters:
- designation- a natural language designator for the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDescriptionSets 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:
- setDescriptionin class- TypeBuilder
- Parameters:
- description- information beyond that required for concise definition of the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDeprecatedSets 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:
- setDeprecatedin class- TypeBuilder
- Parameters:
- deprecated- whether this type is deprecated.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
buildBuilds 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 createdAttributeTypeinstance is returned.Warning: In a future SIS version, the return type may be changed to theorg.opengis.feature.AttributeTypeinterface. This change is pending GeoAPI revision.- Specified by:
- buildin class- TypeBuilder
- Returns:
- the characteristic type.
 
- 
removepublic void remove()Removes this characteristics from theAttributeTypeBuilder. After this method has been invoked, thisCharacteristicTypeBuilderinstance is no longer in the list returned byAttributeTypeBuilder.characteristics()and attempts to invoke any setter method onthiswill cause anIllegalStateExceptionto be thrown.
 
-