Package com.luciad.format.xml.bind.schema

Class TLcdXMLFeaturedObject

java.lang.Object

com.luciad.format.xml.bind.schema.TLcdXMLFeaturedObject

All Implemented Interfaces:

ILcdXMLElementInfo, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable

public class TLcdXMLFeaturedObject
extends Object
implements ILcdXMLElementInfo, ILcdSelfDescribedFeatured, Cloneable

Default implementation for XML domain objects, based on ILcdSelfDescribedFeatured. The decoder/encoder for each format should define how the XML content is mapped on the features of a TLcdXMLFeaturedObject.

Since:

9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TLcdXMLFeaturedObject(TLcdXMLFeaturedDescriptor aFeaturedDescriptor)	Creates a new TLcdXMLFeaturedDescriptor, initialized with the specified TLcdXMLFeaturedDescriptor.

Method Summary

Modifier and Type	Method	Description
boolean	canSetFeature(int aIndex)	Checks whether the specified feature is editable.
TLcdXMLFeaturedObject	clone()
Object	getFeature(int aIndex)	Returns the feature Object at the given index.
Object	getFeature(String aFeatureName)	Returns the value of the specified feature or null if this object does not contain a feature with the given name.
int	getFeatureCount()	Returns the number of features.
TLcdXMLFeaturedDescriptor	getFeaturedDescriptor()	Returns the ILcdFeaturedDescriptor describing this ILcdFeatured object.
QName	getXMLName()	Returns the qualified XML name of this element.
boolean	isNil()	Returns true if the content of this element is nil, false otherwise.
void	setFeature(int aIndex, Object aFeature)	Sets the feature Object at the given index.
void	setFeature(String aFeatureName, Object aValue)	Sets the value of the specified feature.
void	setNil(boolean aNil)	Sets whether the content of this element is nil.
void	setXMLName(QName aName)	Sets the qualified XML name of this element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdXMLFeaturedObject

public TLcdXMLFeaturedObject(TLcdXMLFeaturedDescriptor aFeaturedDescriptor)

Creates a new TLcdXMLFeaturedDescriptor, initialized with the specified TLcdXMLFeaturedDescriptor.

Parameters:

aFeaturedDescriptor - the featured descriptor describing this object.

Method Details

isNil

public boolean isNil()

Description copied from interface: ILcdXMLElementInfo

Returns true if the content of this element is nil, false otherwise.

Specified by:

isNil in interface ILcdXMLElementInfo

Returns:

true if the content of this element is nil, false otherwise.

setNil

public void setNil(boolean aNil)

Description copied from interface: ILcdXMLElementInfo

Sets whether the content of this element is nil.

Specified by:

setNil in interface ILcdXMLElementInfo

Parameters:

aNil - whether the content of this element is nil.

getXMLName

public QName getXMLName()

Description copied from interface: ILcdXMLElementInfo

Returns the qualified XML name of this element.

Specified by:

getXMLName in interface ILcdXMLElementInfo

Returns:

the name of this element.

setXMLName

public void setXMLName(QName aName)

Description copied from interface: ILcdXMLElementInfo

Sets the qualified XML name of this element.

Specified by:

setXMLName in interface ILcdXMLElementInfo

Parameters:

aName - the name of this element.

getFeaturedDescriptor

public TLcdXMLFeaturedDescriptor getFeaturedDescriptor()

Description copied from interface: ILcdSelfDescribedFeatured

Returns the ILcdFeaturedDescriptor describing this ILcdFeatured object.

Specified by:

getFeaturedDescriptor in interface ILcdSelfDescribedFeatured

Returns:

the ILcdFeaturedDescriptor describing this ILcdFeatured object.

canSetFeature

public boolean canSetFeature(int aIndex)

Description copied from interface: ILcdFeatured

Checks whether the specified feature is editable.

Specified by:

canSetFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

true if the feature can be set, false otherwise.

getFeature

public Object getFeature(int aIndex)
                  throws IndexOutOfBoundsException

Description copied from interface: ILcdFeatured

Returns the feature Object at the given index.

Specified by:

getFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

the feature Object at the given index.

Throws:

IndexOutOfBoundsException - when an index is chosen greater than the result of getFeatureCount.

See Also:

• ILcdFeatured.setFeature(int, java.lang.Object)

getFeatureCount

public int getFeatureCount()

Description copied from interface: ILcdFeatured

Returns the number of features.

Specified by:

getFeatureCount in interface ILcdFeatured

Returns:

the number of features.

setFeature

public void setFeature(int aIndex,
 Object aFeature)
                throws IllegalArgumentException

Description copied from interface: ILcdFeatured

Sets the feature Object at the given index.

Specified by:

setFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

aFeature - the new feature Object.

Throws:

IllegalArgumentException - if the feature can't be set.

See Also:

• ILcdFeatured.getFeature(int)
• ILcdFeatured.canSetFeature(int)

getFeature

public Object getFeature(String aFeatureName)

Description copied from interface: ILcdSelfDescribedFeatured

Returns the value of the specified feature or null if this object does not contain a feature with the given name.

Specified by:

getFeature in interface ILcdSelfDescribedFeatured

Parameters:

aFeatureName - the name of the feature

Returns:

the corresponding value or null

setFeature

public void setFeature(String aFeatureName,
 Object aValue)
                throws IllegalArgumentException

Description copied from interface: ILcdSelfDescribedFeatured

Sets the value of the specified feature.

Specified by:

setFeature in interface ILcdSelfDescribedFeatured

Parameters:

aFeatureName - the name of the feature to modify

aValue - the new value for the feature

Throws:

IllegalArgumentException - if the given value is not valid for the specified feature or if the specified feature is not available in this object

toString

public String toString()

Overrides:

toString in class Object

clone

public TLcdXMLFeaturedObject clone()

Overrides:

clone in class Object