Package org.geotools.feature.type

Class Types

Object

Types

Direct Known Subclasses:

Types

public class Types
extends Object

This is a set of utility methods used when implementing types.

This set of classes captures the all important how does it work questions, particularly with respect to super types. FIXME: These methods need a Q&A check to confirm correct use of Super TODO: Cannot tell the difference in intent from FeatureTypes

Author:

Jody Garnett, LISAsoft, Justin Deoliveira, The Open Planning Project

Field Summary

Fields

Modifier and Type	Field	Description
static String	DECLARED_NAMESPACES_MAP	Key for AppSchema declared namespaces on FeatureType user data Map.

Constructor Summary

Constructors

Constructor	Description
Types()

Method Summary

Modifier and Type	Method	Description
static void	assertNameAssignable(FeatureType expected, FeatureType actual)	FeatureType comparison indicating if the description provided by two FeatureTypes is similar to the point data can be exchanged.
static void	assertOrderAssignable(SimpleFeatureType expected, SimpleFeatureType actual)	SimpleFeatureType comparison indicating that data from one FeatureType can be exchanged with another - specifically ensuring that the order / value is a reasonable match with the expected number of attributes on each side and the values correctly assignable.
static Name	degloseName(String prefixedName, NamespaceSupport namespaces)	Takes a prefixed attribute name and returns an Name by looking which namespace belongs the prefix to in AppSchemaDataAccessDTO#getNamespaces().
static PropertyDescriptor	descriptor(ComplexType type, String name)	Returns the first descriptor matching the given local name within the given type.
static PropertyDescriptor	descriptor(ComplexType type, String name, String namespace)	Returns the first descriptor matching the given name + namespace within the given type.
static PropertyDescriptor	descriptor(ComplexType type, Name name)	Returns the first descriptor matching the given name within the given type.
static List<PropertyDescriptor>	descriptors(ComplexType type)	Returns the set of all descriptors of a complex type, including from supertypes.
static List<PropertyDescriptor>	descriptors(ComplexType type, String name)	Returns the set of descriptors matching the given local name within the given type.
static List<PropertyDescriptor>	descriptors(ComplexType type, Name name)	Returns the set of descriptors matching the given name.
static boolean	equals(Name name, QName qName)
static PropertyDescriptor	findDescriptor(ComplexType parentType, String name)	Find a descriptor, taking in to account supertypes AND substitution groups
static PropertyDescriptor	findDescriptor(ComplexType parentType, Name name)	Find a descriptor, taking in to account supertypes AND substitution groups
static String[]	fromNames(Name... attributeNames)	Convenience method for turning an array of qualified names into a list of non qualified names.
static String[]	fromTypeNames(Name... typeNames)	Convenience method for turning an array of qualified names into a list of non qualified names.
static boolean	isSuperType(PropertyType type, PropertyType parent)	Determines if parent is a super type of type
static boolean	isValid(Attribute attribute)	Ensures an attribute value is withing the restrictions of the AttributeDescriptor and AttributeType.
static Name[]	names(ComplexType type)	Returns The name of attributes defined in the type.
static Object	parse(AttributeDescriptor descriptor, Object value)	Do our best to make the provided value line up with the needs of descriptor.
static Object	parse(AttributeType type, Object content)	Converts content into a format which is used to store it internally within an attribute of a specific type.
static Name[]	toNames(String... names)	Creates a set of attribute names from a set of strings.
static String	toPrefixedName(Name name, NamespaceSupport ns)	Converts a Name to a prefixed name (i.e. p:Foo), by looking up the right prefix in the provided NamespaceSupport.
static QName	toQName(Name featurePath)
static QName	toQName(Name featurePath, NamespaceSupport ns)
static Name	toTypeName(QName name)
static Name[]	toTypeNames(String... names)	Creates a set of type names from a set of strings.
static Name	typeName(String name)	Creates a type name from a single non-qualified string.
static Name	typeName(String namespace, String name)	Creates an attribute name from a single non-qualified string.
static Name	typeName(Name name)	Creates a type name from another name.
static void	validate(Attribute attribute)	Validates attribute.
static void	validate(Attribute attribute, Object attributeContent)	Validates content against an attribute.
static void	validate(ComplexAttribute attribute)	Validate complex attribute, including all properties.
static void	validate(ComplexAttribute attribute, Collection<Attribute> content)	Validate content using complex attribute restrictions.
static void	validate(AttributeDescriptor descriptor, Object value)	Ensure that attributeContent is a good value for descriptor.
protected static void	validate(AttributeType type, Object value, boolean isSuper)
static void	validate(AttributeType type, Attribute attribute, Object attributeContent)	Validates content against attribute (using the supplied attribute type).
protected static void	validate(AttributeType type, Attribute attribute, Object attributeContent, boolean isSuper)	Validates content against attribute (using the supplied attribute type).
protected static void	validate(ComplexType type, ComplexAttribute attribute, Collection<Attribute> content)	Validate content using complex attribute and type restrictions.

Methods inherited from class Object

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

Field Detail

DECLARED_NAMESPACES_MAP

public static final String DECLARED_NAMESPACES_MAP

Key for AppSchema declared namespaces on FeatureType user data Map. Value is a Map<String, String>

See Also:

Constant Field Values

Constructor Detail

Types

public Types()

Method Detail

isValid

public static boolean isValid(Attribute attribute)

Ensures an attribute value is withing the restrictions of the AttributeDescriptor and AttributeType.

Returns:

true if the attribute value is valid.

validate

public static void validate(Attribute attribute,
                            Object attributeContent)
                     throws IllegalAttributeException

Validates content against an attribute.

Same result as calling: validate(attribute.getType(), attribute, attributeContent)

Parameters:

attribute - The attribute.

attributeContent - Content of attribute (often attribute.getValue()

Throws:

IllegalAttributeException - In the event that content violates any restrictions specified by the attribute.

validate

public static void validate(AttributeType type,
                            Attribute attribute,
                            Object attributeContent)
                     throws IllegalAttributeException

Validates content against attribute (using the supplied attribute type).

Parameters:

type - AttributeType (often attribute.getType() )

attribute - Attribute being tested

attributeContent - Content of the attribute (often attribute.getValue() )

Throws:

IllegalAttributeException

validate

protected static void validate(AttributeType type,
                               Attribute attribute,
                               Object attributeContent,
                               boolean isSuper)
                        throws IllegalAttributeException

Validates content against attribute (using the supplied attribute type).

Parameters:

type - AttributeType (often attribute.getType() )

attribute - Attribute being tested

attributeContent - Content of the attribute (often attribute.getValue() )

isSuper - True if super type is being checked

Throws:

IllegalAttributeException

validate

public static void validate(AttributeDescriptor descriptor,
                            Object value)
                     throws IllegalAttributeException

Ensure that attributeContent is a good value for descriptor.

Throws:

IllegalAttributeException

parse

public static Object parse(AttributeDescriptor descriptor,
                           Object value)
                    throws IllegalArgumentException

Do our best to make the provided value line up with the needs of descriptor.

This helper method uses the Coverters api to convert the provided value into the required class. If the value is null (and the attribute is not nillable) a default value will be returned.

Parameters:

descriptor - Attribute descriptor we need to supply a value for.

value - The provided value

Returns:

Our best attempt to make a valid value

Throws:

IllegalArgumentException - if we really could not do it.

validate

protected static void validate(AttributeType type,
                               Object value,
                               boolean isSuper)
                        throws IllegalAttributeException

Throws:

IllegalAttributeException

assertNameAssignable

public static void assertNameAssignable(FeatureType expected,
                                        FeatureType actual)

FeatureType comparison indicating if the description provided by two FeatureTypes is similar to the point data can be exchanged. This comparison is really very focused on the name / value contract and is willing to overlook details like length restrictions.

When creating compatible FeatureTypes you will find some systems have different abilities which is reflected in how well they support a given FeatureType.

As an example databases traditionally support variable length strings with a limit of 32 k; while a shapefile is limited to 256 characters. When working with data from both these data sources you will need to make adjustments based on these abilities. If true is returned data conforming to the expected FeatureType can be used with the actual FeatureType.

After assertOrderCovered returns without error the following code will work:

 for( Property property : feature.getProperties() ){
     Object value = property.getValue();

     Property target = newFeature.getProperty( property.getName().getLocalPart() );
     target.setValue( value );
 }
 

Specifically this says that between the two feature types data is assignable on a name by name basis.

Parameters:

expected - Expected FeatureType being used to compare against

actual - Actual FeatureType

assertOrderAssignable

public static void assertOrderAssignable(SimpleFeatureType expected,
                                         SimpleFeatureType actual)

SimpleFeatureType comparison indicating that data from one FeatureType can be exchanged with another - specifically ensuring that the order / value is a reasonable match with the expected number of attributes on each side and the values correctly assignable.

After assertOrderCovered returns without error the following code will work:

 List