Package org.apache.daffodil.api.metadata

Interface ElementMetadata

All Superinterfaces:
Metadata, TermMetadata
All Known Subinterfaces:
ComplexElementMetadata, SimpleElementMetadata
public interface ElementMetadata extends TermMetadata
Common metadata access for all elements, of simple or complex type.

  • Method Details

    • name

      String name()
      Returns:
      the name of this element. In the case of a global/qualified name, this is only the local part of the QName.

    • namespace

      String namespace()
      Returns:
      the namespace URI as a string, or null if no namespace.

    • minimizedScope

      scala.xml.NamespaceBinding minimizedScope()
      Returns:
      the namespace bindings needed to construct an XML element from a Daffodil infoset element of simple or complex type.

    • prefix

      String prefix()
      Returns:
      the namespace prefix part of the XML QName of this component, or null if there is no prefix defined or no namespace.

    • isArray

      boolean isArray()
      Returns:
      true if two or more occurrences are possible. Note that having only 0 or 1 occurrence is not considered an array, but rather an optional element.

    • isOptional

      boolean isOptional()
      Returns:
      true if only 0 or 1 occurrence are possible.

    • toQName

      String toQName()
      Returns:
      the QName string for this element.

    • isNillable

      boolean isNillable()
      Returns:
      true if the element is declared to be nillable.

    • runtimeProperties

      Map<String,String> runtimeProperties()
      Provides access to the runtime properties. This is an extended collection of name-value pairs which are associated with a schema component.

      Runtime properties are intended to use for new ad-hoc property extensions to DFDL. These name-value pairs are visible to infoset outputters as well.

      Returns:
      a java-compatible map of name-value pairs.