Package org.apache.sis.feature.builder
Class OperationWrapper
java.lang.Object
org.apache.sis.feature.builder.TypeBuilder
org.apache.sis.feature.builder.PropertyTypeBuilder
org.apache.sis.feature.builder.OperationWrapper
- All Implemented Interfaces:
Localized
Wraps an existing operation. This package cannot create new operations, except for a few special cases.
The user need to specify fully formed objects.
- Since:
- 0.8
- Version:
- 0.8
-
Field Summary
FieldsFields inherited from class org.apache.sis.feature.builder.PropertyTypeBuilder
maximumOccurs, minimumOccurs
-
Constructor Summary
ConstructorsConstructorDescriptionOperationWrapper
(FeatureTypeBuilder owner, AbstractIdentifiedType operation) Creates a new wrapper for the given operation. -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Returns the wrapped operation.private UnsupportedOperationException
readOnly()
Returns the exception to be thrown for read-only wrapper.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.setMaximumOccurs
(int occurs) Sets the maximum number of property values.setMinimumOccurs
(int occurs) Do not allow a change of multiplicity.setName
(org.opengis.util.GenericName name) Do not allow modifications.Methods inherited from class org.apache.sis.feature.builder.PropertyTypeBuilder
clearCache, createGenericName, createLocalName, dispose, getMaximumOccurs, getMinimumOccurs, isIdentifier, owner, remove, setName, setName
Methods inherited from class org.apache.sis.feature.builder.TypeBuilder
appendStringTo, ensureAlive, ensureNonEmpty, ensureNonNull, errors, forName, getDefaultName, getDefinition, getDescription, getDesignation, getDisplayName, getLocale, getName, identification, initialize, isDeprecated, reset, resources, toString, toStringInternal
-
Field Details
-
operation
The wrapped operation.
-
-
Constructor Details
-
OperationWrapper
OperationWrapper(FeatureTypeBuilder owner, AbstractIdentifiedType operation) Creates a new wrapper for the given operation.
-
-
Method Details
-
build
Returns the wrapped operation.- Specified by:
build
in classPropertyTypeBuilder
- Returns:
- the property type.
-
setMinimumOccurs
Do not allow a change of multiplicity.- Overrides:
setMinimumOccurs
in classPropertyTypeBuilder
- Parameters:
occurs
- the new minimum number of property values.- Returns:
this
for allowing method calls chaining.- See Also:
-
setMaximumOccurs
Description copied from class:PropertyTypeBuilder
Sets the maximum number of property values. If the given number is less than the minimal number of property values, than the minimum is also set to that value.Integer.MAX_VALUE
means that there is no maximum.- Overrides:
setMaximumOccurs
in classPropertyTypeBuilder
- Parameters:
occurs
- the new maximum number of property values.- Returns:
this
for allowing method calls chaining.- See Also:
-
setName
Do not allow modifications.- Overrides:
setName
in classPropertyTypeBuilder
- Parameters:
name
- the generic name (cannot benull
).- Returns:
this
for allowing method calls chaining.- See Also:
-
setDefinition
Description copied from class:PropertyTypeBuilder
Sets a concise definition of the element.- Overrides:
setDefinition
in classPropertyTypeBuilder
- Parameters:
definition
- a concise definition of the element, ornull
if none.- Returns:
this
for allowing method calls chaining.- See Also:
-
setDesignation
Description copied from class:PropertyTypeBuilder
Sets a natural language designator for the element. This can be used as an alternative to the name in user interfaces.- Overrides:
setDesignation
in classPropertyTypeBuilder
- Parameters:
designation
- a natural language designator for the element, ornull
if none.- Returns:
this
for allowing method calls chaining.- See Also:
-
setDescription
Description copied from class:PropertyTypeBuilder
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:
setDescription
in classPropertyTypeBuilder
- Parameters:
description
- information beyond that required for concise definition of the element, ornull
if none.- Returns:
this
for allowing method calls chaining.- See Also:
-
setDeprecated
Description copied from class:PropertyTypeBuilder
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:
setDeprecated
in classPropertyTypeBuilder
- Parameters:
deprecated
- whether this type is deprecated.- Returns:
this
for allowing method calls chaining.- See Also:
-
readOnly
Returns the exception to be thrown for read-only wrapper.
-