com.luciad.format.xml.bind.schema

LuciadLightspeedClass TLcdXMLFeaturedDescriptor

java.lang.Object

com.luciad.format.xml.bind.schema.TLcdXMLFeaturedDescriptor

All Implemented Interfaces:

ILcdCollectionFeaturedDescriptor , ILcdFeaturedDescriptor

public class TLcdXMLFeaturedDescriptor
extends Object
implements 
ILcdCollectionFeaturedDescriptor

Implementation of com.luciad.util.ILcdCollectionFeaturedDescriptor that contains additional XML-related information about the object it describes.

Since:

9.0

Constructor Summary

Constructors

Constructor and Description
TLcdXMLFeaturedDescriptor(TLcdXMLSchemaBasedMapping aSchemaMapping, ILcdCollectionFeaturedDescriptor aCollectionFeaturedDescriptor, TLcdXMLSchemaType aType) Creates a new TLcdXMLFeaturedDescriptor.

Method Summary

Modifier and Type	Method and Description
Class	getFeatureClass(int aIndex) Returns the Class of the feature at the given index.
int	getFeatureCount() Returns the number of features.
Class	getFeatureElementClass(int aFeatureIndex) Returns class of elements in a collection returned by ILcdFeaturedDescriptor.getFeatureClass(int) given that all elements must implement this class.
int	getFeatureIndex(String aName) Returns the index of the given feature name if it exists, -1 otherwise.
String	getFeatureName(int aIndex) Returns the name of the feature at the given index.
TLcdXMLSchemaBasedMapping	getXMLMapping() Returns the TLcdXMLSchemaMapping by which the object was created.
TLcdXMLSchemaType	getXMLType() Returns the XML Schema type of the object this descriptor describes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.util.ILcdFeaturedDescriptor

getFeatureUnitOfMeasure

Constructor Detail

TLcdXMLFeaturedDescriptor

public TLcdXMLFeaturedDescriptor(TLcdXMLSchemaBasedMapping aSchemaMapping,
                                 ILcdCollectionFeaturedDescriptor aCollectionFeaturedDescriptor,
                                 TLcdXMLSchemaType aType)

Creates a new TLcdXMLFeaturedDescriptor.

Parameters:

aSchemaMapping - the XML Mapping containing the XML Schema Type and other mapping information from which this descriptor was created.

aCollectionFeaturedDescriptor - the featured descriptor describing the features.

aType - the XML Schema type this featured descriptor describes.

Method Detail

getXMLMapping

public TLcdXMLSchemaBasedMapping getXMLMapping()

Returns the TLcdXMLSchemaMapping by which the object was created.

Returns:

the TLcdXMLSchemaMapping by which the object was created.

getXMLType

public TLcdXMLSchemaType getXMLType()

Returns the XML Schema type of the object this descriptor describes.

Returns:

the XML Schema type of the object this descriptor describes.

getFeatureElementClass

public Class getFeatureElementClass(int aFeatureIndex)

Description copied from interface: ILcdCollectionFeaturedDescriptor

Returns class of elements in a collection returned by ILcdFeaturedDescriptor.getFeatureClass(int) given that all elements must implement this class. If the feature class is not a collection, this method returns null.

Specified by:

getFeatureElementClass in interface ILcdCollectionFeaturedDescriptor

Parameters:

aFeatureIndex - the index of the feature to retrieve the elements class for. Typically this should only be done for features in which ILcdFeaturedDescriptor.getFeatureClass(int) returns some kind of collection. For other features (with single values), this method should revert to ILcdFeaturedDescriptor.getFeatureClass(int).

Returns:

class of elements in a collection returned by ILcdFeaturedDescriptor.getFeatureClass(int) given that all elements must implement this class. If the feature class is not a collection, this method returns null.

getFeatureClass

public Class getFeatureClass(int aIndex)

Description copied from interface: ILcdFeaturedDescriptor

Returns the Class of the feature at the given index.

Specified by:

getFeatureClass in interface ILcdFeaturedDescriptor

Parameters:

aIndex - a valid feature index.

Returns:

the Class of the feature at the given index.

getFeatureCount

public int getFeatureCount()

Description copied from interface: ILcdFeaturedDescriptor

Returns the number of features.

Specified by:

getFeatureCount in interface ILcdFeaturedDescriptor

Returns:

the number of features.

getFeatureIndex

public int getFeatureIndex(String aName)

Description copied from interface: ILcdFeaturedDescriptor

Returns the index of the given feature name if it exists, -1 otherwise.

Specified by:

getFeatureIndex in interface ILcdFeaturedDescriptor

Parameters:

aName - a feature name.

Returns:

the index of the given feature name if it exists, -1 otherwise.

getFeatureName

public String getFeatureName(int aIndex)

Description copied from interface: ILcdFeaturedDescriptor

Returns the name of the feature at the given index.

Specified by:

getFeatureName in interface ILcdFeaturedDescriptor

Parameters:

aIndex - a valid feature index.

Returns:

the name of the feature at the given index.