public interface OwXMLUtil
Utility interface for structured configuration data access.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Method and Description |
---|---|
String |
getName()
Return the name (tag-name) of this instance
|
Node |
getNode()
return the wrapped DOM Node reference
|
boolean |
getSafeBooleanAttributeValue(String strAttributeName_p,
boolean fDefault_p)
get the value of a boolean attribute [true | false], catch exception
|
boolean |
getSafeBooleanValue(String strNodeName_p,
boolean fDefault_p)
get the value of a sub boolean node [true | false], catch exception
|
List |
getSafeCDATAList()
retrieve a CDATA string list in a subnode
|
List |
getSafeCDATAList(String strNodeName_p)
retrieve a CDATA string list in the node
|
int |
getSafeIntegerAttributeValue(String strAttributeName_p,
int iDefault_p)
get the value of a string attribute, catch exception
|
int |
getSafeIntegerValue(String strNodeName_p,
int fDefault_p)
get the value of a sub Integer node, catch exception
|
List |
getSafeNodeList()
retrieve a node list in a subnode
|
List |
getSafeNodeList(String strNodeName_p)
retrieve a node list in a subnode
|
String |
getSafeStringAttributeValue(String strAttributeName_p,
String strDefault_p)
get the value of a string attribute, catch exception
|
List |
getSafeStringList()
retrieve a string list in the node
|
List |
getSafeStringList(String strNodeName_p)
retrieve a string list in a subnode
|
Set |
getSafeStringSet(String strNodeName_p)
retrieve a string list in a subnode
|
String |
getSafeTextValue(String strDefault_p)
get the value of THE node, catch exception
|
String |
getSafeTextValue(String strNodeName_p,
String strDefault_p)
get the value of a sub text node, catch exception
|
List |
getSafeUtilList(String itemName_p)
get a list with OwXMLUtil's
|
List |
getSafeUtilList(String nodeName_p,
String itemName_p)
get a list with OwXMLUtil's with the given subname
|
Node |
getSubNode(String strNodeName_p)
get the subnode with the given tagname
|
OwXMLUtil |
getSubUtil(String nodeName_p)
get a sub util node with the given name
|
URL |
getURLFromNode(String nodeName_p)
Helper method to create an URL from given configuration node.
|
void |
writeHtmlDump(Writer w_p)
write configuration as HTML to a writer object
|
void |
writeHtmlDumpFiltered(Writer htmlWriter_p,
Map<String,String> hiddenTags)
write configuration as HTML to a writer object and filter xml tags
|
String getName()
OwXMLUtil getSubUtil(String nodeName_p) throws Exception
nodeName_p
- the subnode nameException
List getSafeUtilList(String nodeName_p, String itemName_p)
nodeName_p
- the subnode nameitemName_p
- the name of the item's or null to retrieve all itemsList
List getSafeUtilList(String itemName_p)
itemName_p
- the name of the item's or null to retrieve all itemsList
Node getNode()
Node getSubNode(String strNodeName_p) throws Exception
strNodeName_p
- tag name of requested nodeException
List getSafeNodeList()
List getSafeNodeList(String strNodeName_p)
strNodeName_p
- String name of the subnode with the node listvoid writeHtmlDump(Writer w_p) throws Exception
List getSafeStringList()
List getSafeCDATAList(String strNodeName_p)
List getSafeCDATAList()
List getSafeStringList(String strNodeName_p)
strNodeName_p
- String name of the subnode with the string listSet getSafeStringSet(String strNodeName_p)
strNodeName_p
- String name of the subnode with the string listString getSafeStringAttributeValue(String strAttributeName_p, String strDefault_p)
strAttributeName_p
- name of the String attributestrDefault_p
- Default string in case the attribute could not be foundint getSafeIntegerAttributeValue(String strAttributeName_p, int iDefault_p)
strAttributeName_p
- name of the String attributeiDefault_p
- Default int in case the attribute could not be foundboolean getSafeBooleanAttributeValue(String strAttributeName_p, boolean fDefault_p)
strAttributeName_p
- name of the String attributefDefault_p
- Default string in case the attribute could not be foundboolean getSafeBooleanValue(String strNodeName_p, boolean fDefault_p)
strNodeName_p
- name of the subnodefDefault_p
- Default value in case the node could not be foundint getSafeIntegerValue(String strNodeName_p, int fDefault_p)
strNodeName_p
- name of the subnodefDefault_p
- Default value in case the node could not be foundString getSafeTextValue(String strNodeName_p, String strDefault_p)
strNodeName_p
- name of the text subnodestrDefault_p
- Default string in case the node could not be foundString getSafeTextValue(String strDefault_p)
strDefault_p
- Default string in case the node could not be foundURL getURLFromNode(String nodeName_p) throws MalformedURLException
nodeName_p
- String name of child node, where to extract the URLMalformedURLException
- if the extracted text is not URL conform stringCopyright © 2014 Alfresco Business Solutions. All Rights Reserved.