Package com.luciad.format.xml

Class TLcdXMLElement

java.lang.Object
com.luciad.format.xml.TLcdXMLElement
All Implemented Interfaces:
ILcdXMLEditableElement, ILcdXMLElement, ILcdFeatured, ILcdFeaturedDescriptorProvider, Serializable
public class TLcdXMLElement extends Object implements ILcdXMLEditableElement, ILcdFeatured, ILcdFeaturedDescriptorProvider
Deprecated.
Use of the com.format.xml API has been deprecated. Instead, use the com.format.xml.bind API.
Default implementation of ILcdXMLEditableElement.
See Also:

  • Constructor Details

    • TLcdXMLElement

      public TLcdXMLElement()
      Deprecated.

  • Method Details

    • getName

      public TLcdXMLName getName()
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the full XML name of this element.
      Specified by:
      getName in interface ILcdXMLElement
      Returns:
      the full XML name of this element.

    • getAttributeName

      public TLcdXMLName getAttributeName(int aIndex)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the full XML name of the attribute at the given index.
      Specified by:
      getAttributeName in interface ILcdXMLElement
      Parameters:
      aIndex - the index of the attribute for which to return a name.
      Returns:
      the XML name of the attribute at the given index.

    • getAttributeValue

      public Object getAttributeValue(int aIndex)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the value of the attribute at the given index.
      Specified by:
      getAttributeValue in interface ILcdXMLElement
      Parameters:
      aIndex - the index of the attribute for which to return a value.
      Returns:
      the value of the attribute at the given index.

    • getAttributeValue

      public Object getAttributeValue(TLcdXMLName aAttributeName)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the value of the attribute with the specified name,, or null if no such attribute exists.
      Specified by:
      getAttributeValue in interface ILcdXMLElement
      Parameters:
      aAttributeName - the name of the attribute for which to return a value.
      Returns:
      the value of the attribute with the specified name.

    • getAttributeCount

      public int getAttributeCount()
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the number of attributes present in this XML element.
      Specified by:
      getAttributeCount in interface ILcdXMLElement
      Returns:
      the number of attributes present in this XML element.

    • getContent

      public Object getContent(int aIndex)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the content at the given index. This content can be primitive (a String) or complex. Contents shall be returned in the order they are present in the XML structure, e.g. in the following XML structure: 
      
 <paragraph>
    This is a <bold> bold </bold> text.
 </paragraph>
      the contents of the paragraph element shall be, in that order:
      • a String ("This is a")
      • a child element (an object representing a bold text, including the text as its content
      • another String (" text.").
      Specified by:
      getContent in interface ILcdXMLElement
      Parameters:
      aIndex - the index of the content to be returned.
      Returns:
      the content at the given index.

    • getContentCount

      public int getContentCount()
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the number of contents present in this XML element.
      Specified by:
      getContentCount in interface ILcdXMLElement
      Returns:
      the number of contents present in this XML element.

    • getContent

      public Object getContent(TLcdXMLName aChildName, int aIndex)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the content at the specified position in the list of contents having the specified name.
      Specified by:
      getContent in interface ILcdXMLElement
      Parameters:
      aChildName - the name of the content to be returned.
      aIndex - the position of the content to be returned.
      Returns:
      the content at the specified position in the list of contents having the specified name.

    • getContentCount

      public int getContentCount(TLcdXMLName aChildName)
      Deprecated.
      Description copied from interface: ILcdXMLElement
      Returns the number of contents with the specified name, contained in this XML element.
      Specified by:
      getContentCount in interface ILcdXMLElement
      Parameters:
      aChildName - the XML name of the contents.
      Returns:
      the number of contents present in this XML element.

    • setName

      public void setName(TLcdXMLName aName)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Sets the name of this XML element.
      Specified by:
      setName in interface ILcdXMLEditableElement
      Parameters:
      aName - the name of this XML element.

    • setAttribute

      public void setAttribute(TLcdXMLName aTLcdXMLName, Object aObject)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Adds the given attribute (name,value) pair to this element.
      Specified by:
      setAttribute in interface ILcdXMLEditableElement
      Parameters:
      aTLcdXMLName - the name of the attribute.
      aObject - the value of the attribute.

    • removeAttribute

      public void removeAttribute(TLcdXMLName aName)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Removes the attribute with the given name, if it exists.
      Specified by:
      removeAttribute in interface ILcdXMLEditableElement
      Parameters:
      aName -

    • addContent

      public void addContent(Object aObject)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Adds the given content at the end of this element.
      Specified by:
      addContent in interface ILcdXMLEditableElement
      Parameters:
      aObject - the content to be added.

    • setContent

      public void setContent(int aIndex, Object aContent)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Replaces the content at the specified position with the specified content.
      Specified by:
      setContent in interface ILcdXMLEditableElement
      Parameters:
      aIndex - the position of the content to be replaced.
      aContent - the content to be stored at the specified position.

    • removeContent

      public void removeContent(int aIndex)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Removes the content at the specified position from this XML element. Shifts any subsequent elements to the left.
      Specified by:
      removeContent in interface ILcdXMLEditableElement
      Parameters:
      aIndex - the position of the content to be removed.

    • addContent

      public void addContent(int aIndex, Object aContent)
      Deprecated.
      Description copied from interface: ILcdXMLEditableElement
      Inserts the specified content at the specified position in this XML element. Shifts the element currently at that position and any subsequent elements to the right.
      Specified by:
      addContent in interface ILcdXMLEditableElement
      Parameters:
      aIndex - the position at which to insert the specified content.
      aContent - the content to be inserted.

    • getFeatureCount

      public int getFeatureCount()
      Deprecated.
      Description copied from interface: ILcdFeatured
      Returns the number of features.
      Specified by:
      getFeatureCount in interface ILcdFeatured
      Returns:
      the number of features.

    • getFeature

      public Object getFeature(int aIndex) throws IndexOutOfBoundsException
      Deprecated.
      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:

    • isSimpleElement

      public boolean isSimpleElement(Object aElement)
      Deprecated.

    • setFeature

      public void setFeature(int aIndex, Object aFeature) throws IllegalArgumentException
      Deprecated.
      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:

    • canSetFeature

      public boolean canSetFeature(int aIndex)
      Deprecated.
      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.

    • getFeaturedDescriptor

      public ILcdFeaturedDescriptor getFeaturedDescriptor()
      Deprecated.

    • setFeaturedDescriptor

      public void setFeaturedDescriptor(ILcdFeaturedDescriptor aFeaturedDescriptor)
      Deprecated.

    • getFeaturedDescriptor

      public ILcdFeaturedDescriptor getFeaturedDescriptor(ILcdFeatured aFeatured)
      Deprecated.
      Description copied from interface: ILcdFeaturedDescriptorProvider
      Gets a ILcdFeaturedDescriptor that describes the ILcdFeatured passed.
      Specified by:
      getFeaturedDescriptor in interface ILcdFeaturedDescriptorProvider
      Parameters:
      aFeatured - a featured object to retrieve a featured descriptor for.
      Returns:
      a ILcdFeaturedDescriptor that describes the ILcdFeatured passed.

    • toString

      public String toString()
      Deprecated.
      Returns the XML local name of this object.
      Overrides:
      toString in class Object
      Returns:
      the XML local name of this object.