Class ObjectXML

  • All Implemented Interfaces:
    java.io.Serializable

    public class ObjectXML
    extends java.lang.Object
    implements java.io.Serializable
    Simplicité XML object manager
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectXML()
      Default constructor
      ObjectXML​(ObjectDB obj, java.lang.String action, boolean timestampField, boolean inlineDocs)
      Constructor
      ObjectXML​(ObjectDB obj, java.lang.String action, boolean timestampField, boolean patchMode, boolean functKeysOnly, boolean inlineDocs)
      Constructor
      ObjectXML​(java.lang.String name, java.lang.String action)
      Constructor
      ObjectXML​(java.lang.String name, java.lang.String action, java.lang.String mode)
      Constructor
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addData​(DataXML data)
      Add XML data
      void addData​(java.lang.String[] names, java.lang.String[] values)
      Add data from name/values array
      void addData​(java.util.List<java.lang.String> names, java.util.List<java.lang.Object> values)
      Add data from name/values array
      void addData​(java.util.Map<java.lang.String,​java.lang.Object> data)
      Add data from name:values map
      void addDataList​(java.util.List<DataXML> data)
      Add list of XML data
      java.util.Map<java.lang.String,​java.lang.String> attachTo​(java.lang.String root, java.util.Map<java.lang.String,​java.lang.String> files)
      Attach to
      void clearData()
      Clear all XML data
      static ObjectXML fromJSON​(java.lang.String json)
      Parse JSON object string into an XMl object
      static java.util.List<ObjectXML> fromJSON​(org.json.JSONArray json)
      Parse JSON objects array into an XML object
      static ObjectXML fromJSON​(org.json.JSONObject json)
      Parse JSON object into an XML object
      static ObjectXML fromYAML​(java.lang.String yaml)
      Parse YAML object string into an XML object
      java.lang.String getAction()
      Get action
      java.util.List<DataXML> getData()
      Get XML data
      DataXML getData​(int index)
      Get XML data at specified index
      java.lang.String getDisplay()
      Get object display label
      java.lang.String getIfExists()
      Get if exists property
      java.lang.String getLabel()
      Get label
      java.lang.String getMode()
      Get mode
      java.lang.String getName()
      Get object name
      java.lang.String getRowId()
      Get object row ID
      java.lang.String getUserKey()
      Get object user key
      boolean isOld()
      Get is old object?
      ObjectDB loadObject​(Grant g)
      Load XML data into the temporary instance First XML data is loaded in object fields, all XML data are loaded in the current list
      void setAction​(java.lang.String action)
      Set action
      void setDisplay​(java.lang.String d)
      Set obejct display label
      void setIfExists​(java.lang.String ifexists)
      Set if exists property
      void setLabel​(java.lang.String label)
      Set label
      void setMode​(java.lang.String mode)
      Set mode
      void setName​(java.lang.String name)
      Set object name
      void setOld​(boolean old)
      Set is old object
      void setRowId​(java.lang.String id)
      Set object row ID
      void setUserKey​(java.lang.String uk)
      Set object user key
      java.lang.String toHTML​(Grant g, java.lang.String date)
      Serialize as HTML string
      java.lang.StringBuilder toJSON()
      Serialize as JSON string builder
      java.lang.StringBuilder toJSON​(boolean indent)
      Serialize as JSON string builder
      java.lang.String toString()
      Serialize as XML string
      java.lang.StringBuilder toXML()
      Serialize as XML string builder
      java.lang.StringBuilder toXML​(java.lang.String tab, java.lang.String spacer)
      Serialize as XML string builder
      java.lang.StringBuilder toYAML()
      Serialize as YAML string builder
      ObjectXML undoXML​(ObjectDB obj, java.lang.String action)
      Build the undo changes of action
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ObjectXML

        public ObjectXML()
        Default constructor
      • ObjectXML

        public ObjectXML​(java.lang.String name,
                         java.lang.String action)
        Constructor
        Parameters:
        name - Name
        action - Optional action
      • ObjectXML

        public ObjectXML​(java.lang.String name,
                         java.lang.String action,
                         java.lang.String mode)
        Constructor
        Parameters:
        name - Name
        action - Optional action
        mode - Mode
      • ObjectXML

        public ObjectXML​(ObjectDB obj,
                         java.lang.String action,
                         boolean timestampField,
                         boolean inlineDocs)
        Constructor
        Parameters:
        obj - Object to export
        action - Optional action
        timestampField - Export timestamp fields ?
        inlineDocs - Inline docs/images in XML ?
      • ObjectXML

        public ObjectXML​(ObjectDB obj,
                         java.lang.String action,
                         boolean timestampField,
                         boolean patchMode,
                         boolean functKeysOnly,
                         boolean inlineDocs)
        Constructor
        Parameters:
        obj - Object to export
        action - Optional action
        timestampField - Export timestamp fields ?
        patchMode - Patch mode to export only changed fields ?
        functKeysOnly - Export only functional keys ?
        inlineDocs - Inline docs/images in XML ?
    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Set object name
        Parameters:
        name - Object name
      • setAction

        public void setAction​(java.lang.String action)
        Set action
        Parameters:
        action - Action (one of ObjectXML.ACTION_*)
      • setMode

        public void setMode​(java.lang.String mode)
        Set mode
        Parameters:
        mode - Mode (one of ObjectXML.MODE_*)
      • setIfExists

        public void setIfExists​(java.lang.String ifexists)
        Set if exists property
        Parameters:
        ifexists - If exists property
      • setOld

        public void setOld​(boolean old)
        Set is old object
        Parameters:
        old - Is old object?
      • getName

        public java.lang.String getName()
        Get object name
        Returns:
        Object name
      • getAction

        public java.lang.String getAction()
        Get action
        Returns:
        Action (one of ObjectXML.ACTION_*)
      • getRowId

        public java.lang.String getRowId()
        Get object row ID
        Returns:
        Object row ID
      • setRowId

        public void setRowId​(java.lang.String id)
        Set object row ID
        Parameters:
        id - Obect row ID
      • getDisplay

        public java.lang.String getDisplay()
        Get object display label
        Returns:
        Object display label
      • setDisplay

        public void setDisplay​(java.lang.String d)
        Set obejct display label
        Parameters:
        d - Object display label
      • getUserKey

        public java.lang.String getUserKey()
        Get object user key
        Returns:
        Object user key
      • setUserKey

        public void setUserKey​(java.lang.String uk)
        Set object user key
        Parameters:
        uk - Object user key
      • getIfExists

        public java.lang.String getIfExists()
        Get if exists property
        Returns:
        If exists property
      • isOld

        public boolean isOld()
        Get is old object?
        Returns:
        True if is old object
      • getMode

        public java.lang.String getMode()
        Get mode
        Returns:
        Mode (one of ObjectXML.MODE_*)
      • getData

        public java.util.List<DataXML> getData()
        Get XML data
        Returns:
        XML data list
      • getData

        public DataXML getData​(int index)
        Get XML data at specified index
        Parameters:
        index - Index
        Returns:
        XML data
      • setLabel

        public void setLabel​(java.lang.String label)
        Set label
        Parameters:
        label - Label
      • getLabel

        public java.lang.String getLabel()
        Get label
        Returns:
        Label
      • clearData

        public void clearData()
        Clear all XML data
      • addData

        public void addData​(DataXML data)
        Add XML data
        Parameters:
        data - XML data
      • addData

        public void addData​(java.lang.String[] names,
                            java.lang.String[] values)
        Add data from name/values array
        Parameters:
        names - Names
        values - Values
      • addDataList

        public void addDataList​(java.util.List<DataXML> data)
        Add list of XML data
        Parameters:
        data - List of XML data
      • addData

        public void addData​(java.util.List<java.lang.String> names,
                            java.util.List<java.lang.Object> values)
        Add data from name/values array
        Parameters:
        names - Names
        values - Values
      • addData

        public void addData​(java.util.Map<java.lang.String,​java.lang.Object> data)
        Add data from name:values map
        Parameters:
        data - Data map
      • fromJSON

        public static ObjectXML fromJSON​(java.lang.String json)
        Parse JSON object string into an XMl object
        Parameters:
        json - JSON object string
        Returns:
        XML object
      • fromJSON

        public static ObjectXML fromJSON​(org.json.JSONObject json)
        Parse JSON object into an XML object
        Parameters:
        json - JSON object
        Returns:
        XML object
      • fromJSON

        public static java.util.List<ObjectXML> fromJSON​(org.json.JSONArray json)
        Parse JSON objects array into an XML object
        Parameters:
        json - JSON objects array
        Returns:
        List of XML objects
      • fromYAML

        public static ObjectXML fromYAML​(java.lang.String yaml)
        Parse YAML object string into an XML object
        Parameters:
        yaml - YAML object string
        Returns:
        XML object
      • toString

        public java.lang.String toString()
        Serialize as XML string
        Overrides:
        toString in class java.lang.Object
        Returns:
        XML string
      • toXML

        public java.lang.StringBuilder toXML()
        Serialize as XML string builder
        Returns:
        XML string builder
      • toXML

        public java.lang.StringBuilder toXML​(java.lang.String tab,
                                             java.lang.String spacer)
        Serialize as XML string builder
        Parameters:
        tab - Tabulation
        spacer - Spacer
        Returns:
        XML string builder
      • toJSON

        public java.lang.StringBuilder toJSON()
        Serialize as JSON string builder
        Returns:
        JSON string builder
      • toJSON

        public java.lang.StringBuilder toJSON​(boolean indent)
        Serialize as JSON string builder
        Parameters:
        indent - Indent?
        Returns:
        JSON string builder
      • toYAML

        public java.lang.StringBuilder toYAML()
        Serialize as YAML string builder
        Returns:
        JSON string builder
      • toHTML

        public java.lang.String toHTML​(Grant g,
                                       java.lang.String date)
        Serialize as HTML string
        Parameters:
        g - User rights
        date - optional datetime
        Returns:
        HTML
      • attachTo

        public java.util.Map<java.lang.String,​java.lang.String> attachTo​(java.lang.String root,
                                                                               java.util.Map<java.lang.String,​java.lang.String> files)
        Attach to
        Parameters:
        root - Root
        files - Files to attach
        Returns:
        Map of attached files
      • undoXML

        public ObjectXML undoXML​(ObjectDB obj,
                                 java.lang.String action)
        Build the undo changes of action
        Parameters:
        obj - Object
        action - Action
        Returns:
        XML object
      • loadObject

        public ObjectDB loadObject​(Grant g)
        Load XML data into the temporary instance First XML data is loaded in object fields, all XML data are loaded in the current list
        Parameters:
        g - Grant
        Returns:
        Temporary object representing the XML object