Package com.simplicite.util.integration
Class ObjectXML
- java.lang.Object
-
- com.simplicite.util.integration.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
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACTION_DELETE
Delete actionstatic java.lang.String
ACTION_INSERT
Insert actionstatic java.lang.String
ACTION_QUERY
Query actionstatic java.lang.String
ACTION_UPDATE
Update actionstatic java.lang.String
ACTION_UPSERT
Upsert actionstatic java.lang.String
IF_EXISTS
If existsstatic java.lang.String
IF_NOT_EXISTS
If not existsstatic java.lang.String
MODE_FORM
Form modestatic java.lang.String
MODE_FULL
Full modestatic java.lang.String
MODE_LIST
List modestatic java.lang.String
MODE_PANEL
Panel modestatic java.lang.String
MODE_PREF
User preference mode
-
Constructor Summary
Constructors Constructor Description ObjectXML()
Default constructorObjectXML(ObjectDB obj, java.lang.String action, boolean timestampField, boolean inlineDocs)
ConstructorObjectXML(ObjectDB obj, java.lang.String action, boolean timestampField, boolean patchMode, boolean functKeysOnly, boolean inlineDocs)
ConstructorObjectXML(java.lang.String name, java.lang.String action)
ConstructorObjectXML(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 datavoid
addData(java.lang.String[] names, java.lang.String[] values)
Add data from name/values arrayvoid
addData(java.util.List<java.lang.String> names, java.util.List<java.lang.Object> values)
Add data from name/values arrayvoid
addData(java.util.Map<java.lang.String,java.lang.Object> data)
Add data from name:values mapvoid
addDataList(java.util.List<DataXML> data)
Add list of XML datajava.util.Map<java.lang.String,java.lang.String>
attachTo(java.lang.String root, java.util.Map<java.lang.String,java.lang.String> files)
Attach tovoid
clearData()
Clear all XML datastatic ObjectXML
fromJSON(java.lang.String json)
Parse JSON object string into an XMl objectstatic java.util.List<ObjectXML>
fromJSON(org.json.JSONArray json)
Parse JSON objects array into an XML objectstatic ObjectXML
fromJSON(org.json.JSONObject json)
Parse JSON object into an XML objectstatic ObjectXML
fromYAML(java.lang.String yaml)
Parse YAML object string into an XML objectjava.lang.String
getAction()
Get actionjava.util.List<DataXML>
getData()
Get XML dataDataXML
getData(int index)
Get XML data at specified indexjava.lang.String
getDisplay()
Get object display labeljava.lang.String
getIfExists()
Get if exists propertyjava.lang.String
getLabel()
Get labeljava.lang.String
getMode()
Get modejava.lang.String
getName()
Get object namejava.lang.String
getRowId()
Get object row IDjava.lang.String
getUserKey()
Get object user keyboolean
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 listvoid
setAction(java.lang.String action)
Set actionvoid
setDisplay(java.lang.String d)
Set obejct display labelvoid
setIfExists(java.lang.String ifexists)
Set if exists propertyvoid
setLabel(java.lang.String label)
Set labelvoid
setMode(java.lang.String mode)
Set modevoid
setName(java.lang.String name)
Set object namevoid
setOld(boolean old)
Set is old objectvoid
setRowId(java.lang.String id)
Set object row IDvoid
setUserKey(java.lang.String uk)
Set object user keyjava.lang.String
toHTML(Grant g, java.lang.String date)
Serialize as HTML stringjava.lang.StringBuilder
toJSON()
Serialize as JSON string builderjava.lang.StringBuilder
toJSON(boolean indent)
Serialize as JSON string builderjava.lang.String
toString()
Serialize as XML stringjava.lang.StringBuilder
toXML()
Serialize as XML string builderjava.lang.StringBuilder
toXML(java.lang.String tab, java.lang.String spacer)
Serialize as XML string builderjava.lang.StringBuilder
toYAML()
Serialize as YAML string builderObjectXML
undoXML(ObjectDB obj, java.lang.String action)
Build the undo changes of action
-
-
-
Field Detail
-
ACTION_INSERT
public static final java.lang.String ACTION_INSERT
Insert action- See Also:
- Constant Field Values
-
ACTION_UPSERT
public static final java.lang.String ACTION_UPSERT
Upsert action- See Also:
- Constant Field Values
-
ACTION_UPDATE
public static final java.lang.String ACTION_UPDATE
Update action- See Also:
- Constant Field Values
-
ACTION_DELETE
public static final java.lang.String ACTION_DELETE
Delete action- See Also:
- Constant Field Values
-
ACTION_QUERY
public static final java.lang.String ACTION_QUERY
Query action- See Also:
- Constant Field Values
-
MODE_FULL
public static final java.lang.String MODE_FULL
Full mode- See Also:
- Constant Field Values
-
MODE_LIST
public static final java.lang.String MODE_LIST
List mode- See Also:
- Constant Field Values
-
MODE_FORM
public static final java.lang.String MODE_FORM
Form mode- See Also:
- Constant Field Values
-
MODE_PANEL
public static final java.lang.String MODE_PANEL
Panel mode- See Also:
- Constant Field Values
-
MODE_PREF
public static final java.lang.String MODE_PREF
User preference mode- See Also:
- Constant Field Values
-
IF_EXISTS
public static final java.lang.String IF_EXISTS
If exists- See Also:
- Constant Field Values
-
IF_NOT_EXISTS
public static final java.lang.String IF_NOT_EXISTS
If not exists- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ObjectXML
public ObjectXML()
Default constructor
-
ObjectXML
public ObjectXML(java.lang.String name, java.lang.String action)
Constructor- Parameters:
name
- Nameaction
- Optional action
-
ObjectXML
public ObjectXML(java.lang.String name, java.lang.String action, java.lang.String mode)
Constructor- Parameters:
name
- Nameaction
- Optional actionmode
- Mode
-
ObjectXML
public ObjectXML(ObjectDB obj, java.lang.String action, boolean timestampField, boolean inlineDocs)
Constructor- Parameters:
obj
- Object to exportaction
- Optional actiontimestampField
- 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 exportaction
- Optional actiontimestampField
- 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
- Namesvalues
- 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
- Namesvalues
- 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 classjava.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
- Tabulationspacer
- 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 rightsdate
- 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
- Rootfiles
- 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
- Objectaction
- Action- Returns:
- XML object
-
-