Class ModelSection

java.lang.Object
org.simpleframework.xml.core.ModelSection
All Implemented Interfaces:
Iterable<String>, Section
class ModelSection extends Object implements Section
The ModelSection represents a section that is backed by a Model instance. This is used to expose the XML structure of a schema class. In addition to wrapping the model this will also apply a Style to the names of the attributes and elements of the class schema.

  • Field Details

    • attributes

      private LabelMap attributes
      Represents a mapping between styled names and attributes.

    • elements

      private LabelMap elements
      Represents a mapping between styled names and elements.

    • models

      private ModelMap models
      Represents a mapping between styled names and models.

    • model

      private Model model
      This is the model that contains the elements and attributes.

  • Constructor Details

    • ModelSection

      public ModelSection(Model model)
      Constructor for the ModelSection object. This is used to wrap a Model in such a way that it can not be modified. This allows it to be used concurrently.
      Parameters:
      model - this is the model this section will wrap

  • Method Details

    • getName

      public String getName()
      This is used to return the name of the section. The name is must be a valid XML element name. It is used when a style is applied to a path as the section name must be styled.
      Specified by:
      getName in interface Section
      Returns:
      this returns the name of this section instance

    • getPrefix

      public String getPrefix()
      This is used to acquire the path prefix for the section. The path prefix is used when the section is transformed in to an XML structure. This ensures that the XML element created to represent the section contains the optional prefix.
      Specified by:
      getPrefix in interface Section
      Returns:
      this returns the prefix for this section

    • getPath

      public String getPath(String name) throws Exception
      This is used to acquire the full element path for this section. The element path is simply the fully qualified path for this expression with the provided name appended. If this is an empty path, the provided name is returned.
      Specified by:
      getPath in interface Section
      Parameters:
      name - this is the name of the element to be used
      Returns:
      a fully qualified path for the specified name
      Throws:
      Exception

    • getAttribute

      public String getAttribute(String name) throws Exception
      This is used to acquire the full attribute path for this section. The attribute path is simply the fully qualified path for this expression with the provided name appended. If this is an empty path, the provided name is returned.
      Specified by:
      getAttribute in interface Section
      Parameters:
      name - this is the name of the attribute to be used
      Returns:
      a fully qualified path for the specified name
      Throws:
      Exception

    • iterator

      public Iterator<String> iterator()
      This will return the names of all elements contained within the model. This includes the names of all XML elements that have been registered as well as any other models that have been added. Iteration is done in an ordered manner, according to the registration of elements and models.
      Specified by:
      iterator in interface Iterable<String>
      Returns:
      an ordered and styled list of elements and models

    • isSection

      public boolean isSection(String name) throws Exception
      To differentiate between a section and an element this can be used. When iterating over the elements within the section the names of both elements and sections are provided. So in order to determine how to interpret the structure this can be used.
      Specified by:
      isSection in interface Section
      Parameters:
      name - this is the name of the element to be determined
      Returns:
      this returns true if the name represents a section
      Throws:
      Exception

    • getModels

      public ModelMap getModels() throws Exception
      Returns a LabelMap that contains the details for all fields and methods marked with XML annotations. All of the attribute annotations are considered and gathered by name in this map. Also, if there is an associated Style for serialization the attribute names are renamed with this.
      Returns:
      returns the attributes associated with this section
      Throws:
      Exception

    • getText

      public Label getText() throws Exception
      This is used to acquire the text label for this section if one has been specified. A text label can only exist in a section if there are no elements associated with the section and the section is not composite, as in it does not contain any further sections.
      Specified by:
      getText in interface Section
      Returns:
      this returns the text label for this section
      Throws:
      Exception

    • getAttributes

      public LabelMap getAttributes() throws Exception
      Returns a LabelMap that contains the details for all fields and methods marked with XML annotations. All of the attribute annotations are considered and gathered by name in this map. Also, if there is an associated Style for serialization the attribute names are renamed with this.
      Specified by:
      getAttributes in interface Section
      Returns:
      returns the attributes associated with this section
      Throws:
      Exception

    • getElements

      public LabelMap getElements() throws Exception
      Returns a LabelMap that contains the details for all fields and methods marked with XML annotations. All of the element annotations are considered and gathered by name in this map. Also, if there is an associated Style for serialization the element names are renamed with this.
      Specified by:
      getElements in interface Section
      Returns:
      returns the elements associated with this section
      Throws:
      Exception

    • getElement

      public Label getElement(String name) throws Exception
      Returns the named element as a Label object. For convenience this method is provided so that when iterating over the names of the elements in the section a specific one of interest can be acquired.

      To ensure that elements of the same name are not referenced more than once this will remove the element once acquired. This ensures that they are visited only once in serialization.

      Specified by:
      getElement in interface Section
      Parameters:
      name - the name of the element that is to be acquired
      Returns:
      this returns the label associated with the name
      Throws:
      Exception

    • getSection

      public Section getSection(String name) throws Exception
      Returns the named section as a Section object. For convenience this method is provided so that when iterating over the names of the elements in the section a specific one of interest can be acquired.

      To ensure that models of the same name are not referenced more than once this will remove the model once acquired. This ensures that they are visited only once in serialization.

      Specified by:
      getSection in interface Section
      Parameters:
      name - the name of the element that is to be acquired
      Returns:
      this returns the section associated with the name
      Throws:
      Exception