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

final class OperationWrapper
extends PropertyTypeBuilder

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

Fields

Modifier and Type	Field	Description
private final AbstractIdentifiedType	operation	The wrapped operation.

Fields inherited from class org.apache.sis.feature.builder.PropertyTypeBuilder

maximumOccurs, minimumOccurs

Constructor Summary

Constructors

Constructor	Description
OperationWrapper(FeatureTypeBuilder owner, AbstractIdentifiedType operation)	Creates a new wrapper for the given operation.

Method Summary

Modifier and Type	Method	Description
AbstractIdentifiedType	build()	Returns the wrapped operation.
private UnsupportedOperationException	readOnly()	Returns the exception to be thrown for read-only wrapper.
PropertyTypeBuilder	setDefinition(CharSequence definition)	Sets a concise definition of the element.
PropertyTypeBuilder	setDeprecated(boolean deprecated)	Sets whether the type is deprecated.
PropertyTypeBuilder	setDescription(CharSequence description)	Sets optional information beyond that required for concise definition of the element.
PropertyTypeBuilder	setDesignation(CharSequence designation)	Sets a natural language designator for the element.
PropertyTypeBuilder	setMaximumOccurs(int occurs)	Sets the maximum number of property values.
PropertyTypeBuilder	setMinimumOccurs(int occurs)	Do not allow a change of multiplicity.
PropertyTypeBuilder	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

operation

private final AbstractIdentifiedType operation

The wrapped operation.

Constructor Details

OperationWrapper

OperationWrapper(FeatureTypeBuilder owner,
 AbstractIdentifiedType operation)

Creates a new wrapper for the given operation.

Method Details

build

public AbstractIdentifiedType build()

Returns the wrapped operation.

Specified by:

build in class PropertyTypeBuilder

Returns:

the property type.

setMinimumOccurs

public PropertyTypeBuilder setMinimumOccurs(int occurs)

Do not allow a change of multiplicity.

Overrides:

setMinimumOccurs in class PropertyTypeBuilder

Parameters:

occurs - the new minimum number of property values.

Returns:

this for allowing method calls chaining.

See Also:

• PropertyTypeBuilder.getMinimumOccurs()

setMaximumOccurs

public PropertyTypeBuilder setMaximumOccurs(int occurs)

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 class PropertyTypeBuilder

Parameters:

occurs - the new maximum number of property values.

Returns:

this for allowing method calls chaining.

See Also:

• PropertyTypeBuilder.getMaximumOccurs()

setName

public PropertyTypeBuilder setName(org.opengis.util.GenericName name)

Do not allow modifications.

Overrides:

setName in class PropertyTypeBuilder

Parameters:

name - the generic name (cannot be null).

Returns:

this for allowing method calls chaining.

See Also:

• TypeBuilder.getName()
• TypeBuilder.setName(CharSequence)
• AbstractIdentifiedType.NAME_KEY

setDefinition

public PropertyTypeBuilder setDefinition(CharSequence definition)

Description copied from class: PropertyTypeBuilder

Sets a concise definition of the element.

Overrides:

setDefinition in class PropertyTypeBuilder

Parameters:

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

Returns:

this for allowing method calls chaining.

See Also:

• TypeBuilder.getDefinition()
• AbstractIdentifiedType.DEFINITION_KEY

setDesignation

public PropertyTypeBuilder setDesignation(CharSequence designation)

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 class PropertyTypeBuilder

Parameters:

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

Returns:

this for allowing method calls chaining.

See Also:

• TypeBuilder.getDesignation()
• AbstractIdentifiedType.DESIGNATION_KEY

setDescription

public PropertyTypeBuilder setDescription(CharSequence description)

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 class PropertyTypeBuilder

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:

• TypeBuilder.getDescription()
• AbstractIdentifiedType.DESCRIPTION_KEY

setDeprecated

public PropertyTypeBuilder setDeprecated(boolean deprecated)

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 class PropertyTypeBuilder

Parameters:

deprecated - whether this type is deprecated.

Returns:

this for allowing method calls chaining.

See Also:

• TypeBuilder.isDeprecated()
• AbstractIdentifiedType.DEPRECATED_KEY

readOnly

private UnsupportedOperationException readOnly()

Returns the exception to be thrown for read-only wrapper.