Interface ComplexType

    • Method Detail

      • getNamespace

        Namespace getNamespace()
        Gets the namespace used by this complex type.
        Returns:
        the namespace or Namespace.DEFAULT_NS if none was specified
      • getField

        Field getField​(String name)
        Gets the field with the given name.

        If the name is non-prefixed the first matching field is returned if any is found. If the name is prefixed then the right field is returned if any is found.

        Parameters:
        name - the field name
        Returns:
        the field
      • getField

        Field getField​(QName name)
        Gets the field having the given name.
        Parameters:
        name - the name
        Returns:
        the field or null if no field with that name was found
      • addField

        Field addField​(String name,
                       Type type,
                       String defaultValue,
                       int flags,
                       Collection<Constraint> constraints)
        Adds a field to this complex type.

        If the given name is not prefixed it will be prefixed with the type prefix. If one was specified otherwise the default prefix will be used (e.g. "" - no prefix). If the given name is prefixed it will be stored as is (using the specified prefix).

        Parameters:
        name - the field name
        type - the field type
        defaultValue - an optional default value (null if none)
        flags - optional flags
        Returns:
        the created field
      • hasField

        boolean hasField​(String name)
        Tests whether this type defines the given field name.

        The name is supposed to be non prefixed.

        Parameters:
        name - the field name
        Returns:
        true if the field exists, false otherwise
      • hasFields

        boolean hasFields()
        Tests whether this type has any field defined.

        If a complex type has no fields, it is considered as unstructured and it accepts any field with any type and name.

        Returns:
        true if the at least one field exists, false otherwise
      • getFields

        Collection<Field> getFields()
        Gets all fields as a (field name, field type) map.
        Returns:
        the fields map
      • getFieldsCount

        int getFieldsCount()
        Gets the number of fields defined for this complex type.
        Returns:
        the fields count