org.apache.sis.feature.builder

Class AssociationRoleBuilder

Object

TypeBuilder

PropertyTypeBuilder

AssociationRoleBuilder

All Implemented Interfaces:

Localized

public final class AssociationRoleBuilder
extends PropertyTypeBuilder

Describes one association from the Feature­Type to be built by an Feature­Type­Builder to another Feature­Type. A different instance of Association­Role­Builder exists for each feature association to describe. Those instances are created preferably by Feature­Type­Builder.add­Association(Feature­Type), or in case of cyclic reference by Feature­Type­Builder.add­Association(Generic­Name).

Since:

0.8

See Also:

Default­Association­Role, Feature­Type­Builder.add­Association(Default­Feature­Type), Feature­Type­Builder.add­Association(Generic­Name)

Defined in the sis-feature module

Method Summary

Modifier and Type	Method and Description
DefaultAssociationRole	build() Builds the association role from the information specified to this builder.
AssociationRoleBuilder	setDefinition(CharSequence definition) Sets a concise definition of the element.
AssociationRoleBuilder	setDeprecated(boolean deprecated) Sets whether the type is deprecated.
AssociationRoleBuilder	setDescription(CharSequence description) Sets optional information beyond that required for concise definition of the element.
AssociationRoleBuilder	setDesignation(CharSequence designation) Sets a natural language designator for the element.
AssociationRoleBuilder	setMaximumOccurs(int occurs) Sets the maximum number of associations.
AssociationRoleBuilder	setMinimumOccurs(int occurs) Sets the minimum number of associations.
AssociationRoleBuilder	setName(CharSequence... components) Sets the Feature­Association­Role name as a string in the given scope.
AssociationRoleBuilder	setName(CharSequence localPart) Sets the Feature­Association­Role name as a simple string (local name).
AssociationRoleBuilder	setName(GenericName name) Sets the Feature­Association­Role name as a generic name.

Methods inherited from class PropertyTypeBuilder

get­Maximum­Occurs, get­Minimum­Occurs, remove

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 Detail

setName

public AssociationRoleBuilder setName(GenericName name)

Sets the Feature­Association­Role name as a generic name. If another name was defined before this method call, that previous value will be discarded.

Overrides:

set­Name in class Type­Builder

Parameters:

name - the generic name (can not 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 AssociationRoleBuilder setName(CharSequence localPart)

Sets the Feature­Association­Role name as a simple string (local name). The namespace will be the value specified by the last call to Feature­Type­Builder.set­Name­Space(Char­Sequence), but that namespace will not be visible in the string representation unless the fully qualified name is requested.

This convenience method creates a Local­Name instance from the given Char­Sequence, then delegates to set­Name(Generic­Name).

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

Sets the Feature­Association­Role name as a string in the given scope. The components array must contain at least one element. The last component (the tip) will be sufficient in many cases for calls to the Abstract­Feature.get­Property(String) method. The other elements before the last one are optional and can be used for resolving ambiguity. They will be visible as the name path.

Example: a call to set­Name("A", "B", "C") will create a "A:B:C" name. An association built with this name can be obtained from a feature by a call to feature.get­Property("C") if there is no ambiguity, or otherwise by a call to feature.get­Property("B:C") (if non-ambiguous) or feature.get­Property("A:B:C").

In addition to the path specified by the components array, the name may also contain a namespace specified by the last call to Feature­Type­Builder.set­Name­Space(Char­Sequence). 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 Local­Name or Scoped­Name instance depending on whether the names array contains exactly 1 element or more than 1 element, then delegates to set­Name(Generic­Name).

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

setMinimumOccurs

public AssociationRoleBuilder setMinimumOccurs(int occurs)

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

Overrides:

set­Minimum­Occurs in class Property­Type­Builder

Parameters:

occurs - the new minimum number of associations.

Returns:

this for allowing method calls chaining.

See Also:

Property­Type­Builder.get­Minimum­Occurs()

setMaximumOccurs

public AssociationRoleBuilder setMaximumOccurs(int occurs)

Sets the maximum number of associations. If the given number is less than the minimal number of associations, than the minimum is also set to that value.

Overrides:

set­Maximum­Occurs in class Property­Type­Builder

Parameters:

occurs - the new maximum number of associations.

Returns:

this for allowing method calls chaining.

See Also:

Property­Type­Builder.get­Maximum­Occurs()

setDefinition

public AssociationRoleBuilder 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 AssociationRoleBuilder 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 AssociationRoleBuilder 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 AssociationRoleBuilder 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 DefaultAssociationRole build()

Builds the association role from the information specified to this builder. If a role has already been built and this builder state has not changed since the role creation, then the previously created Feature­Association­Role instance is returned.

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

Specified by:

build in class Property­Type­Builder

Returns:

the association role.