Package com.luciad.format.xml

Interface ILcdXMLElement

All Known Subinterfaces:
ILcdXMLEditableElement
All Known Implementing Classes:
TLcdXMLElement
public interface ILcdXMLElement
Deprecated.
Use of the com.format.xml API has been deprecated. Instead, use the com.format.xml.bind API.
A general interface representing an XML element, providing access to its attributes and contents.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAttributeCount()
    Deprecated.
    Returns the number of attributes present in this XML element.
    TLcdXMLName
    getAttributeName(int aIndex)
    Deprecated.
    Returns the full XML name of the attribute at the given index.
    Object
    getAttributeValue(int aIndex)
    Deprecated.
    Returns the value of the attribute at the given index.
    Object
    getAttributeValue(TLcdXMLName aAttributeName)
    Deprecated.
    Returns the value of the attribute with the specified name,, or null if no such attribute exists.
    Object
    getContent(int aIndex)
    Deprecated.
    Returns the content at the given index.
    Object
    getContent(TLcdXMLName aChildName, int aIndex)
    Deprecated.
    Returns the content at the specified position in the list of contents having the specified name.
    int
    getContentCount()
    Deprecated.
    Returns the number of contents present in this XML element.
    int
    getContentCount(TLcdXMLName aChildName)
    Deprecated.
    Returns the number of contents with the specified name, contained in this XML element.
    TLcdXMLName
    getName()
    Deprecated.
    Returns the full XML name of this element.

  • Method Details

    • getName

      TLcdXMLName getName()
      Deprecated.
      Returns the full XML name of this element.
      Returns:
      the full XML name of this element.

    • getAttributeName

      TLcdXMLName getAttributeName(int aIndex)
      Deprecated.
      Returns the full XML name of the attribute at the given index.
      Parameters:
      aIndex - the index of the attribute for which to return a name.
      Returns:
      the XML name of the attribute at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAttributeCount().

    • getAttributeValue

      Object getAttributeValue(int aIndex)
      Deprecated.
      Returns the value of the attribute at the given index.
      Parameters:
      aIndex - the index of the attribute for which to return a value.
      Returns:
      the value of the attribute at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAttributeCount().

    • getAttributeCount

      int getAttributeCount()
      Deprecated.
      Returns the number of attributes present in this XML element.
      Returns:
      the number of attributes present in this XML element.

    • getAttributeValue

      Object getAttributeValue(TLcdXMLName aAttributeName)
      Deprecated.
      Returns the value of the attribute with the specified name,, or null if no such attribute exists.
      Parameters:
      aAttributeName - the name of the attribute for which to return a value.
      Returns:
      the value of the attribute with the specified name.

    • getContent

      Object getContent(int aIndex)
      Deprecated.
      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.").
      Parameters:
      aIndex - the index of the content to be returned.
      Returns:
      the content at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getContentCount().

    • getContentCount

      int getContentCount()
      Deprecated.
      Returns the number of contents present in this XML element.
      Returns:
      the number of contents present in this XML element.

    • getContentCount

      int getContentCount(TLcdXMLName aChildName)
      Deprecated.
      Returns the number of contents with the specified name, contained in this XML element.
      Parameters:
      aChildName - the XML name of the contents.
      Returns:
      the number of contents present in this XML element.

    • getContent

      Object getContent(TLcdXMLName aChildName, int aIndex)
      Deprecated.
      Returns the content at the specified position in the list of contents having the specified name.
      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.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getContentCount(aChildName).