sapphire.xml

Class PropertyList

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

sapphire.xml.PropertyList

All Implemented Interfaces:

com.labvantage.sapphire.gwt.shared.JSONable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.Map

public class PropertyList
extends java.util.HashMap
implements java.lang.Cloneable, java.lang.Comparable, com.labvantage.sapphire.gwt.shared.JSONable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_MODULES
static java.lang.String	ALL_ROLES
protected java.util.HashMap	attributes
static java.lang.String	ENCRYPT_PREFIX
protected java.lang.String	id
static java.lang.String	JSON_PROPERTYLISTATTRIBUTES
static java.lang.String	JSON_PROPERTYLISTID
static java.lang.String	JSON_PROPERTYLISTSEQUENCE
protected boolean	usePropertyValues

Fields inherited from interface com.labvantage.sapphire.gwt.shared.JSONable

TYPE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
PropertyList()
PropertyList(java.util.HashMap mapProps) Creates a new PropertyList from a HashMap
PropertyList(org.json.JSONObject jsonObject) Creates a new propertylist from a JSONObhect (created with toJSONObject)
PropertyList(com.labvantage.sapphire.PropertyList propertyList) Creates a new PropertyList from a (core) PropertyList
PropertyList(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	addPropertyList(org.w3c.dom.Node propertyList, boolean merge, java.lang.String propertyTreeNodeId)
void	addPropertyList(com.labvantage.sapphire.PropertyList propertyList)
int	compareTo(java.lang.Object o)
PropertyList	copy()
PropertyList	copy(java.lang.String rolelist, java.lang.String modulelist)
PropertyList	copy(java.lang.String rolelist, java.lang.String modulelist, java.util.Set<java.lang.String> inactiveRoles)
PropertyList	copy(java.lang.String languageid, TranslationProcessor tp)
PropertyList	copy(java.lang.String languageid, TranslationProcessor tp, java.lang.String rolelist, java.lang.String modulelist, java.util.Set<java.lang.String> inactiveRoles)
PropertyList	copy(java.lang.String languageid, TranslationProcessor tp, java.lang.String rolelist, java.lang.String modulelist, java.util.Set<java.lang.String> inactiveRoles, java.lang.String guimode)
void	deleteProperty(java.lang.String propertyid)
boolean	equals(PropertyList compare)
java.lang.String	findProperty(java.lang.String findId)
PropertyList	findPropertyList(java.lang.String findId)
java.lang.String	getAttribute(java.lang.String attributeId)
java.util.HashMap	getAttributes()
protected java.lang.String	getAttributesText(java.util.HashMap attribs, java.lang.String ignorelist)
PropertyListCollection	getCollection(java.lang.String propertyId) Returns the propertylistcollection for the specified property.
PropertyListCollection	getCollectionNotNull(java.lang.String propertyId) Returns the propertylistcollection for the specified property.
java.lang.String	getDecryptedProperty(java.lang.String propertyId)
java.util.ArrayList	getFilteredCollections(java.lang.String propertyId, java.util.HashMap filterMap)
java.lang.String	getId() Returns the PropertyList identifier
java.lang.String	getModuleListNodeid()
PropertyValue	getParentPropertyValue() Returns the PropertyValue for the property that this propertylist resides in.
java.lang.String	getPreviousModuleList()
java.lang.String	getPreviousRoleList()
java.lang.String	getPreviousSequence()
java.lang.String	getProperty(java.lang.String propertyId)
java.lang.String	getProperty(java.lang.String propertyId, java.lang.String defaultValue)
PropertyList	getPropertyList(java.lang.String propertyId) Returns the propertylist for the specified property.
PropertyList	getPropertyListNotNull(java.lang.String propertyId) Returns the propertylist for the specified property.
java.lang.String	getPropertyTreeNodeId() Returns the treenodeid when the propertylist has been populated from a propertytree
java.lang.String	getPropertyTreeNodeId(java.lang.String propertyId)
PropertyValue	getPropertyValue(java.lang.String propertyId)
java.lang.String	getRoleListNodeid()
long	getSequence()
boolean	isCollection(java.lang.String propertyId)
boolean	isPropertyList(java.lang.String propertyId)
boolean	isSimple(java.lang.String propertyId)
void	mergeAttributes(java.util.HashMap attributes)
void	mergeAttributes(java.util.HashMap attributes, java.lang.String propertyTreeNodeid)
protected void	propertyToXML(java.lang.StringBuffer xml, java.lang.String propertyid, java.lang.Object value, PropertyValue pv, java.lang.String roleList, java.lang.String moduleList, int level)
void	setAttribute(java.lang.String id, java.lang.String value) Sets a single attribute on this propertylist
void	setAttribute(java.lang.String id, java.lang.String value, boolean deep) Sets a single attribute on this propertylist with the option of cascading
void	setAttributes(java.util.HashMap attributes) Sets the attributes for the PropertyList
void	setDatabaseid(java.lang.String databaseid) Sets the databaseid
void	setDbms(java.lang.String dbms) Sets the database type
void	setGuiMode(java.lang.String guiMode) Sets the guimode value to return when encountering a guimode-based property like $R{high:xxx:|:medium:yyy:|:low:zzz}
void	setId(java.lang.String id) Set the PropertyList identifier
void	setJSONString(java.lang.String jsonString)
void	setJSONString(java.lang.String jsonString, boolean blankIsPropertyList)
void	setLanguage(java.lang.String language) Sets the language when getting translated toXMLString
void	setLocale(java.util.Locale locale)
void	setProperty(java.lang.String propertyId, PropertyList value)
void	setProperty(java.lang.String propertyId, PropertyListCollection value)
void	setProperty(java.lang.String propertyId, java.lang.String value)
void	setPropertyList(java.io.File file)
void	setPropertyList(java.io.File file, boolean merge)
void	setPropertyList(java.io.File file, boolean merge, boolean cache)
void	setPropertyList(java.lang.String xml)
void	setPropertyList(java.lang.String xml, boolean merge)
void	setPropertyList(java.lang.String xml, boolean merge, boolean cache)
void	setPropertyList(java.lang.String xml, boolean merge, java.lang.String propertyTreeNodeid, boolean cache)
void	setPropertyTree(java.io.File file, java.lang.String nodeId)
void	setPropertyTree(java.io.File file, java.lang.String nodeId, boolean setDefaults)
void	setPropertyTree(org.w3c.dom.Node contextNode, java.lang.String nodeId, boolean setDefaults)
void	setPropertyTree(java.lang.String xml, java.lang.String nodeId)
void	setPropertyTree(java.lang.String xml, java.lang.String nodeId, boolean setDefaults)
void	setPropertyTree(java.lang.String xml, java.lang.String nodeId, boolean setDefaults, boolean cache)
boolean	setPropertyTreeDefaults(org.w3c.dom.Node propertyListDef)
boolean	setPropertyTreeDefaults(com.labvantage.sapphire.xml.PropertyDefaultList propertyDefaultList)
void	setPropertyTreeDefaults(java.lang.String propertyTree)
void	setSequence(long seq)
void	setSequence(java.lang.String seq)
void	setTimeZone(java.util.TimeZone timezone)
void	setTranslationProcessor(TranslationProcessor tp) Translation processor to be used when translating in toXMLString()
void	setUsePropertyValues(boolean usePropertyValues) States whether to use PropertyValues.
org.w3c.dom.Element	toElement(org.w3c.dom.Document doc)
org.json.JSONObject	toJSONObject()
org.json.JSONObject	toJSONObject(boolean includeAttributes)
org.json.JSONObject	toJSONObject(boolean includeAttributes, boolean includeEmpties)
java.lang.String	toJSONString()
java.lang.String	toJSONString(boolean includeAttributes)
java.lang.String	toJSONString(boolean includeAttributes, boolean includeEmpties)
java.lang.String	toString()
java.lang.String	toXMLString()
java.lang.String	toXMLString(int level)
java.lang.String	toXMLString(java.lang.String roleList, java.lang.String moduleList)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

id

protected java.lang.String id

attributes

protected java.util.HashMap attributes

usePropertyValues

protected boolean usePropertyValues

ALL_ROLES

public static final java.lang.String ALL_ROLES

See Also:

Constant Field Values

ALL_MODULES

public static final java.lang.String ALL_MODULES

See Also:

Constant Field Values

ENCRYPT_PREFIX

public static final java.lang.String ENCRYPT_PREFIX

See Also:

Constant Field Values

JSON_PROPERTYLISTID

public static final java.lang.String JSON_PROPERTYLISTID

See Also:

Constant Field Values

JSON_PROPERTYLISTSEQUENCE

public static final java.lang.String JSON_PROPERTYLISTSEQUENCE

See Also:

Constant Field Values

JSON_PROPERTYLISTATTRIBUTES

public static final java.lang.String JSON_PROPERTYLISTATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

PropertyList

public PropertyList()

PropertyList

public PropertyList(java.lang.String id)

PropertyList

public PropertyList(java.util.HashMap mapProps)

Creates a new PropertyList from a HashMap

Parameters:

mapProps -

PropertyList

public PropertyList(com.labvantage.sapphire.PropertyList propertyList)

Creates a new PropertyList from a (core) PropertyList

Parameters:

propertyList -

PropertyList

public PropertyList(org.json.JSONObject jsonObject)

Creates a new propertylist from a JSONObhect (created with toJSONObject)

Parameters:

jsonObject -

Method Detail

setId

public void setId(java.lang.String id)

Set the PropertyList identifier

Parameters:

id - The PropertyList identifier

getId

public java.lang.String getId()

Returns the PropertyList identifier

Returns:

the Propertylist Identifier

setUsePropertyValues

public void setUsePropertyValues(boolean usePropertyValues)

States whether to use PropertyValues. Using property values gives additional information (attributes etc) about an individual property. Also allows you to navigate up the properrytlist tree.

Parameters:

usePropertyValues - Whether to use PropertyValues

setGuiMode

public void setGuiMode(java.lang.String guiMode)

Sets the guimode value to return when encountering a guimode-based property like $R{high:xxx:|:medium:yyy:|:low:zzz}

Parameters:

guiMode - the guimode value should be returned by the propertylist

setLanguage

public void setLanguage(java.lang.String language)

Sets the language when getting translated toXMLString

Parameters:

language - the language to translate to

setDbms

public void setDbms(java.lang.String dbms)

Sets the database type

Parameters:

dbms - the database type (ORA, MSS)

setDatabaseid

public void setDatabaseid(java.lang.String databaseid)

Sets the databaseid

Parameters:

databaseid - the database id

getParentPropertyValue

public PropertyValue getParentPropertyValue()

Returns the PropertyValue for the property that this propertylist resides in. Note that the parent property will be of type propertylist or collection. The root (top-most) propertylist has no parent propertyvalue. PropertyValues must be turned on (with setUsePropertyValues) for this function to work

Returns:

the PropertyValue for the property this PropertyList belongs to.

setTranslationProcessor

public void setTranslationProcessor(TranslationProcessor tp)

Translation processor to be used when translating in toXMLString()

Parameters:

tp - TranslationProcessor to use

getPropertyTreeNodeId

public java.lang.String getPropertyTreeNodeId()

Returns the treenodeid when the propertylist has been populated from a propertytree

Returns:

the name of the tree node

setAttributes

public void setAttributes(java.util.HashMap attributes)

Sets the attributes for the PropertyList

Parameters:

attributes -

setAttribute

public void setAttribute(java.lang.String id,
                         java.lang.String value)

Sets a single attribute on this propertylist

Parameters:

id - attribute identifier

value - attribute value

setAttribute

public void setAttribute(java.lang.String id,
                         java.lang.String value,
                         boolean deep)

Sets a single attribute on this propertylist with the option of cascading

Parameters:

id - attribute identifier

value - attribute value

deep - setting this to true will set the same attribute on all nested propertylists and collections

mergeAttributes

public void mergeAttributes(java.util.HashMap attributes)

mergeAttributes

public void mergeAttributes(java.util.HashMap attributes,
                            java.lang.String propertyTreeNodeid)

getAttributes

public java.util.HashMap getAttributes()

getAttribute

public java.lang.String getAttribute(java.lang.String attributeId)

getPreviousSequence

public java.lang.String getPreviousSequence()

getPreviousRoleList

public java.lang.String getPreviousRoleList()

getPreviousModuleList

public java.lang.String getPreviousModuleList()

getRoleListNodeid

public java.lang.String getRoleListNodeid()

getModuleListNodeid

public java.lang.String getModuleListNodeid()

setSequence

public void setSequence(long seq)

setSequence

public void setSequence(java.lang.String seq)

getSequence

public long getSequence()

setPropertyList

public void setPropertyList(java.io.File file)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.io.File file,
                            boolean merge)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.io.File file,
                            boolean merge,
                            boolean cache)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.lang.String xml)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.lang.String xml,
                            boolean merge)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.lang.String xml,
                            boolean merge,
                            java.lang.String propertyTreeNodeid,
                            boolean cache)
                     throws SapphireException

Throws:

SapphireException

setPropertyList

public void setPropertyList(java.lang.String xml,
                            boolean merge,
                            boolean cache)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(java.io.File file,
                            java.lang.String nodeId)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(java.lang.String xml,
                            java.lang.String nodeId)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(java.io.File file,
                            java.lang.String nodeId,
                            boolean setDefaults)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(java.lang.String xml,
                            java.lang.String nodeId,
                            boolean setDefaults)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(java.lang.String xml,
                            java.lang.String nodeId,
                            boolean setDefaults,
                            boolean cache)
                     throws SapphireException

Throws:

SapphireException

setPropertyTree

public void setPropertyTree(org.w3c.dom.Node contextNode,
                            java.lang.String nodeId,
                            boolean setDefaults)
                     throws SapphireException

Throws:

SapphireException

addPropertyList

public void addPropertyList(com.labvantage.sapphire.PropertyList propertyList)

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.String value)

deleteProperty

public void deleteProperty(java.lang.String propertyid)

setProperty

public void setProperty(java.lang.String propertyId,
                        PropertyList value)

setProperty

public void setProperty(java.lang.String propertyId,
                        PropertyListCollection value)

addPropertyList

public void addPropertyList(org.w3c.dom.Node propertyList,
                            boolean merge,
                            java.lang.String propertyTreeNodeId)
                     throws SapphireException

Throws:

SapphireException

setPropertyTreeDefaults

public void setPropertyTreeDefaults(java.lang.String propertyTree)
                             throws SapphireException

Throws:

SapphireException

setPropertyTreeDefaults

public boolean setPropertyTreeDefaults(org.w3c.dom.Node propertyListDef)
                                throws SapphireException

Throws:

SapphireException

setPropertyTreeDefaults

public boolean setPropertyTreeDefaults(com.labvantage.sapphire.xml.PropertyDefaultList propertyDefaultList)
                                throws SapphireException

Throws:

SapphireException

toXMLString

public java.lang.String toXMLString()

toXMLString

public java.lang.String toXMLString(int level)

toXMLString

public java.lang.String toXMLString(java.lang.String roleList,
                                    java.lang.String moduleList)

propertyToXML

protected void propertyToXML(java.lang.StringBuffer xml,
                             java.lang.String propertyid,
                             java.lang.Object value,
                             PropertyValue pv,
                             java.lang.String roleList,
                             java.lang.String moduleList,
                             int level)

getAttributesText

protected java.lang.String getAttributesText(java.util.HashMap attribs,
                                             java.lang.String ignorelist)

getDecryptedProperty

public java.lang.String getDecryptedProperty(java.lang.String propertyId)

getProperty

public java.lang.String getProperty(java.lang.String propertyId)

getProperty

public java.lang.String getProperty(java.lang.String propertyId,
                                    java.lang.String defaultValue)

getPropertyValue

public PropertyValue getPropertyValue(java.lang.String propertyId)

getPropertyList

public PropertyList getPropertyList(java.lang.String propertyId)

Returns the propertylist for the specified property. WARNING: This method may return a null propertylist. Use getPropertyListNotNull to ensure that a valid propertylist is always returned

Parameters:

propertyId - The property containing the propertylist

Returns:

propertyList A propertylist or null if one does not exist

getCollection

public PropertyListCollection getCollection(java.lang.String propertyId)

Returns the propertylistcollection for the specified property. WARNING: This method may return a null propertylistcollection. Use getCollectionNotNull to ensure that a valid collection is always returned

Parameters:

propertyId - The property containing the collection

Returns:

propertyListCollection A propertylistcollection or null if one does not exist

getPropertyListNotNull

public PropertyList getPropertyListNotNull(java.lang.String propertyId)

Returns the propertylist for the specified property. If no propertylist exists, a new empty one is created, added into the current propertylist and returned

Parameters:

propertyId - The property containing the propertylist

Returns:

propertyList A valid propertylist

getCollectionNotNull

public PropertyListCollection getCollectionNotNull(java.lang.String propertyId)

Returns the propertylistcollection for the specified property. If no propertylistcollection exists, a new empty one is created, added into the current propertylist and returned

Parameters:

propertyId - The property containing the collection

Returns:

propertyListCollection A valid propertylistcollection

isSimple

public boolean isSimple(java.lang.String propertyId)

isPropertyList

public boolean isPropertyList(java.lang.String propertyId)

isCollection

public boolean isCollection(java.lang.String propertyId)

getPropertyTreeNodeId

public java.lang.String getPropertyTreeNodeId(java.lang.String propertyId)

getFilteredCollections

public java.util.ArrayList getFilteredCollections(java.lang.String propertyId,
                                                  java.util.HashMap filterMap)

copy

public PropertyList copy()

copy

public PropertyList copy(java.lang.String rolelist,
                         java.lang.String modulelist)

copy

public PropertyList copy(java.lang.String rolelist,
                         java.lang.String modulelist,
                         java.util.Set<java.lang.String> inactiveRoles)

copy

public PropertyList copy(java.lang.String languageid,
                         TranslationProcessor tp)

copy

public PropertyList copy(java.lang.String languageid,
                         TranslationProcessor tp,
                         java.lang.String rolelist,
                         java.lang.String modulelist,
                         java.util.Set<java.lang.String> inactiveRoles)

copy

public PropertyList copy(java.lang.String languageid,
                         TranslationProcessor tp,
                         java.lang.String rolelist,
                         java.lang.String modulelist,
                         java.util.Set<java.lang.String> inactiveRoles,
                         java.lang.String guimode)

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document doc)

findProperty

public java.lang.String findProperty(java.lang.String findId)

findPropertyList

public PropertyList findPropertyList(java.lang.String findId)

equals

public boolean equals(PropertyList compare)

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap

toJSONObject

public org.json.JSONObject toJSONObject()

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeAttributes)

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeAttributes,
                                        boolean includeEmpties)

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface com.labvantage.sapphire.gwt.shared.JSONable

toJSONString

public java.lang.String toJSONString(boolean includeAttributes,
                                     boolean includeEmpties)

toJSONString

public java.lang.String toJSONString(boolean includeAttributes)

setJSONString

public void setJSONString(java.lang.String jsonString)
                   throws org.json.JSONException

Throws:

org.json.JSONException

setJSONString

public void setJSONString(java.lang.String jsonString,
                          boolean blankIsPropertyList)
                   throws org.json.JSONException

Throws:

org.json.JSONException

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

setLocale

public void setLocale(java.util.Locale locale)

setTimeZone

public void setTimeZone(java.util.TimeZone timezone)