Package com.saperion.structures

Class Structure

  • All Implemented Interfaces:
    java.io.Serializable
    public class Structure
extends java.lang.Object
implements java.io.Serializable
    A structure bean for structuring content stream with their variables.
    Author:
    dam
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected ContentStream[] contentStreams
      This structures contents.
      protected int selectedImage
      Selected image of this structure.
      protected java.util.Map<java.lang.String,​java.lang.String> variables
      Thus structures variables.

    • Constructor Summary

      Constructors 
      Constructor Description
      Structure​(ContentStream[] content)
      Creates a new UpdateDocumentInfo.

    • Field Detail

      • contentStreams

        protected transient ContentStream[] contentStreams
        This structures contents.

      • variables

        protected java.util.Map<java.lang.String,​java.lang.String> variables
        Thus structures variables.

      • selectedImage

        protected int selectedImage
        Selected image of this structure.

    • Constructor Detail

      • Structure

        public Structure​(@Nonnull
                 ContentStream[] content)
        Creates a new UpdateDocumentInfo.
        Parameters:
        content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.

    • Method Detail

      • getContent

        public ContentStream[] getContent()
        Returns:
        content stream

      • setSelectedImage

        public void setSelectedImage​(int elementNumber)
        Parameters:
        elementNumber - Element to mark

      • getSelectedImage

        public int getSelectedImage()
        Returns:
        Element to mark

      • getVariables

        public java.util.Map<java.lang.String,​java.lang.String> getVariables()
        Returns this structures variables.
        Returns:
        this structures variables.

      • addVariable

        public Structure addVariable​(java.lang.String varName,
                             java.lang.String varValue)
        Adds a variable to this structure.
        Parameters:
        varName - The name of the variable.
        varValue - The value of the variable.
        Returns:
        This structure.