Module org.apache.sis.feature

Package org.apache.sis.feature.builder

Class PropertyTypeBuilder

Object

TypeBuilder

PropertyTypeBuilder

All Implemented Interfaces:

Localized

Direct Known Subclasses:

Association­Role­Builder, Attribute­Type­Builder

public abstract class PropertyTypeBuilder
extends TypeBuilder

Describes one property of the Feature­Type to be built by an Feature­Type­Builder. A different instance of Property­Type­Builder exists for each property to describe. Those instances can be created by:

• Feature­Type­Builder.add­Attribute(Class)
• Feature­Type­Builder.add­Attribute(Default­Attribute­Type) for using an existing attribute as a template
• Feature­Type­Builder.add­Association(Default­Feature­Type)
• Feature­Type­Builder.add­Association(Generic­Name)
• Feature­Type­Builder.add­Association(Default­Association­Role) for using an existing association as a template

Since:

0.8

Method Summary

Modifier and Type	Method	Description
abstract Abstract­Identified­Type	build()	Builds the property type from the information specified to this builder.
final int	get­Maximum­Occurs()	Returns the maximum number of property values.
int	get­Minimum­Occurs()	Returns the minimum number of property values.
void	remove()	Removes this property from the Feature­Type­Builder.
Property­Type­Builder	set­Definition(Char­Sequence definition)	Sets a concise definition of the element.
Property­Type­Builder	set­Deprecated(boolean deprecated)	Sets whether the type is deprecated.
Property­Type­Builder	set­Description(Char­Sequence description)	Sets optional information beyond that required for concise definition of the element.
Property­Type­Builder	set­Designation(Char­Sequence designation)	Sets a natural language designator for the element.
Property­Type­Builder	set­Maximum­Occurs(int occurs)	Sets the maximum number of property values.
Property­Type­Builder	set­Minimum­Occurs(int occurs)	Sets the minimum number of property values.
Property­Type­Builder	set­Name(Char­Sequence local­Part)	Sets the Property­Type name as a simple string (local name).
Property­Type­Builder	set­Name(Char­Sequence... components)	Sets the Property­Type name as a string in the given scope.
Property­Type­Builder	set­Name(Generic­Name name)	Sets the Property­Type name as a generic name.

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 PropertyTypeBuilder setName(GenericName name)

Sets the Property­Type name as a generic name. See the parent class for more information.

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 PropertyTypeBuilder setName(CharSequence localPart)

Sets the Property­Type name as a simple string (local name). See the parent class for more information.

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 PropertyTypeBuilder setName(CharSequence... components)

Sets the Property­Type name as a string in the given scope. See the parent class for more information.

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()

getMinimumOccurs

public int getMinimumOccurs()

Returns the minimum number of property values. The returned value is greater than or equal to zero.

Returns:

the minimum number of property values.

See Also:

• Default­Attribute­Type.get­Minimum­Occurs()

setMinimumOccurs

public PropertyTypeBuilder setMinimumOccurs(int occurs)

Sets the minimum number of property values. If the given number is greater than the maximal number of property values, than the maximum is also set to that value.

Parameters:

occurs - the new minimum number of property values.

Returns:

this for allowing method calls chaining.

See Also:

• get­Minimum­Occurs()

getMaximumOccurs

public final int getMaximumOccurs()

Returns the maximum number of property values. The returned value is greater than or equal to the get­Minimum­Occurs() value. If there is no maximum, then this method returns Integer.MAX_VALUE.

Returns:

the maximum number of property values, or Integer.MAX_VALUE if none.

See Also:

• Default­Attribute­Type.get­Maximum­Occurs()

setMaximumOccurs

public PropertyTypeBuilder setMaximumOccurs(int occurs)

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.

Parameters:

occurs - the new maximum number of property values.

Returns:

this for allowing method calls chaining.

See Also:

• get­Maximum­Occurs()

setDefinition

public PropertyTypeBuilder 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 PropertyTypeBuilder 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 PropertyTypeBuilder 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 PropertyTypeBuilder 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 abstract AbstractIdentifiedType build()
                                      throws IllegalStateException

Builds the property 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 Property­Type instance is returned (see Attribute­Type­Builder.build() for more information).

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

Specified by:

build in class Type­Builder

Returns:

the property type.

Throws:

Illegal­State­Exception - if the builder contains inconsistent information.

remove

public void remove()

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