Package org.apache.sis.feature.builder
Class AssociationRoleBuilder
Object
TypeBuilder
PropertyTypeBuilder
AssociationRoleBuilder
- All Implemented Interfaces:
- Localized
Describes one association from the 
FeatureType to be built by an FeatureTypeBuilder to another
 FeatureType. A different instance of AssociationRoleBuilder exists for each feature association
 to describe. Those instances are created preferably by FeatureTypeBuilder.addAssociation(FeatureType),
 or in case of cyclic reference by FeatureTypeBuilder.addAssociation(GenericName).- Since:
- 0.8
- See Also:
Defined in the sis-feature module
- 
Method SummaryModifier and TypeMethodDescriptionbuild()Builds the association role from the information specified to this builder.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 associations.setMinimumOccurs(int occurs) Sets the minimum number of associations.setName(CharSequence localPart) Sets theFeatureAssociationRolename as a simple string (local name).setName(CharSequence... components) Sets theFeatureAssociationRolename as a string in the given scope.setName(GenericName name) Sets theFeatureAssociationRolename as a generic name.Methods inherited from class PropertyTypeBuildergetMaximumOccurs, getMinimumOccurs, removeMethods inherited from class TypeBuildergetDefinition, getDescription, getDesignation, getLocale, getName, isDeprecated, toString
- 
Method Details- 
setNameSets theFeatureAssociationRolename as a generic name. If another name was defined before this method call, that previous value will be discarded.- Overrides:
- setNamein class- PropertyTypeBuilder
- Parameters:
- name- the generic name (cannot be- null).
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setNameSets theFeatureAssociationRolename as a simple string (local name). The namespace will be the value specified by the last call toFeatureTypeBuilder.setNameSpace(CharSequence), but that namespace will not be visible in the string representation unless the fully qualified name is requested.This convenience method creates a LocalNameinstance from the givenCharSequence, then delegates tosetName(GenericName).- Overrides:
- setNamein class- PropertyTypeBuilder
- Parameters:
- localPart- the local part of the generic name as a- Stringor- InternationalString.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setNameSets theFeatureAssociationRolename as a string in the given scope. Thecomponentsarray must contain at least one element. The last component (the tip) will be sufficient in many cases for calls to theAbstractFeature.getProperty(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 toIn addition to the path specified by thesetName("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 tofeature.getProperty("C")if there is no ambiguity, or otherwise by a call tofeature.getProperty("B:C")(if non-ambiguous) orfeature.getProperty("A:B:C").componentsarray, the name may also contain a namespace specified by the last call toFeatureTypeBuilder.setNameSpace(CharSequence). 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 LocalNameorScopedNameinstance depending on whether thenamesarray contains exactly 1 element or more than 1 element, then delegates tosetName(GenericName).- Overrides:
- setNamein class- PropertyTypeBuilder
- Parameters:
- components- the name components as an array of- Stringor- InternationalStringinstances.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setMinimumOccursSets 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:
- setMinimumOccursin class- PropertyTypeBuilder
- Parameters:
- occurs- the new minimum number of associations.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setMaximumOccursSets 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.Integer.MAX_VALUEmeans that there is no maximum.- Overrides:
- setMaximumOccursin class- PropertyTypeBuilder
- Parameters:
- occurs- the new maximum number of associations.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDefinitionSets a concise definition of the element.- Overrides:
- setDefinitionin class- PropertyTypeBuilder
- Parameters:
- definition- a concise definition of the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDesignationSets a natural language designator for the element. This can be used as an alternative to the name in user interfaces.- Overrides:
- setDesignationin class- PropertyTypeBuilder
- Parameters:
- designation- a natural language designator for the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDescriptionSets 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:
- setDescriptionin class- PropertyTypeBuilder
- Parameters:
- description- information beyond that required for concise definition of the element, or- nullif none.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
setDeprecatedSets 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:
- setDeprecatedin class- PropertyTypeBuilder
- Parameters:
- deprecated- whether this type is deprecated.
- Returns:
- thisfor allowing method calls chaining.
- See Also:
 
- 
buildBuilds 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 createdFeatureAssociationRoleinstance is returned.Warning: In a future SIS version, the return type may be changed to theorg.opengis.feature.FeatureAssociationRoleinterface. This change is pending GeoAPI revision.- Specified by:
- buildin class- PropertyTypeBuilder
- Returns:
- the association role.
 
 
-