org.apache.sis.feature.builder

Class PropertyTypeBuilder

Object

TypeBuilder

PropertyTypeBuilder

All Implemented Interfaces:

Localized

Direct Known Subclasses:

AssociationRoleBuilder, AttributeTypeBuilder

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

Defined in the sis-feature module

Method Summary

Modifier and Type	Method and Description
abstract AbstractIdentifiedType	build() Builds the property type from the information specified to this builder.
int	getMaximumOccurs() Returns the maximum number of property values.
int	getMinimumOccurs() Returns the minimum number of property values.
void	remove() Removes this property from the Feature­Type­Builder.
PropertyTypeBuilder	setMaximumOccurs(int occurs) Sets the maximum number of property values.
PropertyTypeBuilder	setMinimumOccurs(int occurs) Sets the minimum number of property values.

Methods inherited from class TypeBuilder

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

Methods inherited from class Object

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

Method Detail

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.

Parameters:

occurs - the new maximum number of property values.

Returns:

this for allowing method calls chaining.

See Also:

get­Maximum­Occurs()

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.