org.mdiutil.xml.tree

Class XMLNodeUtilities2

java.lang.Object

org.mdiutil.xml.tree.XMLNodeUtilities2

All Implemented Interfaces:

XMLNodeUtilitiesOptions

public class XMLNodeUtilities2
extends Object
implements XMLNodeUtilitiesOptions

Various utilities concerning XML content. Contrary to the XMLNodeUtilities2, class, all methods are instance methods.

Field Summary

Fields inherited from interface org.mdiutil.xml.tree.XMLNodeUtilitiesOptions

ALLOW_INTERNAL_READERS, KEEP_LINE_NUMBERS, NAMESPACE_AWARE, PRESERVE_SPACE, SHOW_EXCEPTIONS, SHOW_WARNINGS

Constructor Summary

Constructors

Constructor and Description
XMLNodeUtilities2()
XMLNodeUtilities2(XMLNodeUtilities2 utils)

Method Summary

Modifier and Type	Method and Description
void	applyConfiguration(XMLParserConfiguration config) Apply a parser configuration.
Charset	getCharset() Return the charset to use to write the content.
EntityListResolver	getEntityListResolver() Return the EntityListResolver which can manage entity resolution in XML files.
ErrorHandler	getErrorHandler() Return the error handler wich will be fired for parsing errors detected by the underlying parser. null by default.
Map<String,Boolean>	getFeatures() Return the underlying parser factory features.
XMLNode	getNode(File file) Return the Node from a file.
XMLNode	getNode(Reader reader) Return the Node from a Reader.
XMLNode	getNode(String str) Return the Node from a String.
XMLNode	getNode(URL xmlURL) Return the root Node from an XML URL.
XMLNode	getNode(URL xmlURL, String comment) Return the root Node from an XML URL, with a comment.
Map<String,Object>	getProperties() Return the underlying parser properties.
XMLRoot	getRootNode(File file) Return the root Node from a file.
XMLRoot	getRootNode(Reader reader) Return the root Node from a Reader.
XMLRoot	getRootNode(String str) Return the root Node from a String.
XMLRoot	getRootNode(URL xmlURL) Return the root Node from an XML URL.
URL	getSchema() Return the schema of the underlying parser.
boolean	isAllowingInternalReaders() Return true if internal readers creation are allowed in the underlying parser instance.
boolean	isKeepingLineNumbers() Return true if the line numbers should be kept during the parsing.
boolean	isKeepingPrefixes() Return true if the underlying parser must keep the prefixes.
boolean	isNameSpaceAware() Return true if the parser is namespace-aware.
boolean	isPreservingSpaces() Return true if spaces should be preserved.
boolean	isShowingExceptions() Return true if the parser shows the exceptions encountered during the parsing.
boolean	isShowingWarnings() Return true if the parser shows the warnings encountered during the parsing.
boolean	isValidating() Return true if the underlying parser is validating.
void	keepLineNumbers(boolean keepLineNumbers) Set if the line numbers should be kept during the parsing.
void	preserveSpaces(boolean preserveSpace) Set if spaces should be preserved.
String	print(XMLNode node, int indentation) Print as a String the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, boolean isOrdered, File outputFile) Save in a File the content of an XML file under a root Node.
String	print(XMLNode node, int indentation, boolean isOrdered, NodeSerializer serializer) Print as a String the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, boolean isOrdered, NodeSerializer serializer, File outputFile) Save in a File the content of an XML file under a root Node.
String	print(XMLNode node, int indentation, boolean isOrdered, NodeSerializer serializer, String encoding) Print as a String the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, boolean isOrdered, NodeSerializer serializer, URL outputURL) Save in an URL the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, boolean isOrdered, URL outputURL) Save in an URL the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, File outputFile) Save in a File the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, File outputFile, boolean isOrdered, NodeSerializer serializer, String encoding) Save in a File the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, File outputFile, String encoding) Save in a File the content of an XML file under a root Node.
String	print(XMLNode node, int indentation, String encoding) Print as a String the content of an XML file under a root Node.
void	print(XMLNode node, int indentation, URL outputURL) Save in an URL the content of an XML file under a root Node.
void	resetConfiguration() Reset the configuration of the underlying parser (reatures and properties).
List<XMLNode>	search(XMLNode node, List<QName> qnames, boolean deep) Search for the children nodes having a specified qualified name among a list of names.
List<XMLNode>	search(XMLNode node, QName[] qnames, boolean deep) Search for the children nodes having a specified qualified name among a list of names.
List<XMLNode>	search(XMLNode node, QName qname, boolean deep) Search for the children nodes having a specified qualified name.
List<XMLNode>	search(XMLNode node, String name, boolean deep) Search for the children nodes having a specified name.
XMLNode	searchFirst(XMLNode node, List<QName> qnames, boolean deep) Search for the first child node having a specified qualified name among a list of qualified names.
XMLNode	searchFirst(XMLNode node, QName[] qnames, boolean deep) Search for the first child node having a specified qualified name among a list of qualified names.
XMLNode	searchFirst(XMLNode node, QName qname, boolean deep) Search for the first child node having a specified qualified name.
XMLNode	searchFirst(XMLNode node, String name, boolean deep) Search for the first child node having a specified name.
XMLNode	searchFirstForNames(XMLNode node, List<String> names, boolean deep) Search for the first child node having a specified name among a list of names.
XMLNode	searchFirstForNames(XMLNode node, String[] names, boolean deep) Search for the first child node having a specified name among a list of names.
List<XMLNode>	searchForNames(XMLNode node, List<String> names, boolean deep) Search for the children nodes having a specified name among a list of names.
List<XMLNode>	searchForNames(XMLNode node, String[] names, boolean deep) Search for the children nodes having a specified name among a list of names.
void	setAllowInternalReaders(boolean allowInternalReaders) Set if internal readers creation are allowed in the underlying parser instance.
void	setCharset(Charset charset) Set the charset to use to write the content.
void	setEntityListResolver(EntityListResolver resolver) Set the EntityListResolver which can manage entity resolution in XML files.
void	setErrorHandler(ErrorHandler errorHandler) Set an error handler wich will be fired for parsing errors detected by the underlying parser.
void	setFeature(String name, boolean value) Set a underlying parser factory feature.
void	setKeepPrefixes(boolean keepPrefixes) Set if the underlying parser must keep the prefixes.
void	setNameSpaceAware(boolean isNameSpaceAware) Set if the parser is namespace-aware.
void	setOptions(int options) Set the underlying parser options.
void	setProperty(String name, Object value) Set an underlying parser property.
void	setSchema(URL schema) Set the schema of the underlying parser.
void	setValidating(boolean isValidating) Set if the underlying parser is validating.
void	showExceptions(boolean isShowingExceptions) Set if the parser shows the exceptions encountered during the parsing.
void	showWarnings(boolean isShowingWarnings) Set if the parser shows the warnings encountered during the parsing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLNodeUtilities2

public XMLNodeUtilities2()

XMLNodeUtilities2

public XMLNodeUtilities2(XMLNodeUtilities2 utils)

Method Detail

applyConfiguration

public void applyConfiguration(XMLParserConfiguration config)

Apply a parser configuration.

Parameters:

config - the configuration

setCharset

public void setCharset(Charset charset)

Set the charset to use to write the content. The default charset is StandardCharsets.UTF_8.

Parameters:

charset - the charset

getCharset

public Charset getCharset()

Return the charset to use to write the content.

Returns:

the charset

setSchema

public void setSchema(URL schema)

Set the schema of the underlying parser.

Parameters:

schema - the schema of the underlying parser

getSchema

public URL getSchema()

Return the schema of the underlying parser.

Returns:

the schema of the underlying parser

setValidating

public void setValidating(boolean isValidating)

Set if the underlying parser is validating.

Parameters:

isValidating - true if the underlying parser is validating

isValidating

public boolean isValidating()

Return true if the underlying parser is validating.

Returns:

true if the underlying parser is validating

setOptions

public void setOptions(int options)

Set the underlying parser options.

Parameters:

options - the options

showExceptions

public void showExceptions(boolean isShowingExceptions)

Set if the parser shows the exceptions encountered during the parsing.

Parameters:

isShowingExceptions - true if the parser shows the exceptions encountered during the parsing

isShowingExceptions

public boolean isShowingExceptions()

Return true if the parser shows the exceptions encountered during the parsing.

Returns:

true if the parser shows the exceptions encountered during the parsing

showWarnings

public void showWarnings(boolean isShowingWarnings)

Set if the parser shows the warnings encountered during the parsing.

Parameters:

isShowingWarnings - true if the parser shows the warnings encountered during the parsing

isShowingWarnings

public boolean isShowingWarnings()

Return true if the parser shows the warnings encountered during the parsing.

Returns:

true if the parser shows the warnings encountered during the parsing

preserveSpaces

public void preserveSpaces(boolean preserveSpace)

Set if spaces should be preserved.

Parameters:

preserveSpace - true if spaces should be preserved

isPreservingSpaces

public boolean isPreservingSpaces()

Return true if spaces should be preserved.

Returns:

true if spaces should be preserved

keepLineNumbers

public void keepLineNumbers(boolean keepLineNumbers)

Set if the line numbers should be kept during the parsing.

Parameters:

keepLineNumbers - true if the line numbers should be kept during the parsing

isKeepingLineNumbers

public boolean isKeepingLineNumbers()

Return true if the line numbers should be kept during the parsing.

Returns:

true if the line numbers should be kept during the parsing

setNameSpaceAware

public void setNameSpaceAware(boolean isNameSpaceAware)

Set if the parser is namespace-aware.

Parameters:

isNameSpaceAware - true if the parser is namespace-aware

isNameSpaceAware

public boolean isNameSpaceAware()

Return true if the parser is namespace-aware.

Returns:

true if the parser is namespace-aware

setKeepPrefixes

public void setKeepPrefixes(boolean keepPrefixes)

Set if the underlying parser must keep the prefixes. It will ot contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default).

Parameters:

keepPrefixes - true if the parser must keep the prefixes

isKeepingPrefixes

public boolean isKeepingPrefixes()

Return true if the underlying parser must keep the prefixes.

Returns:

true if the parser must keep the prefixes

setAllowInternalReaders

public void setAllowInternalReaders(boolean allowInternalReaders)

Set if internal readers creation are allowed in the underlying parser instance.

Parameters:

allowInternalReaders - true if internal readers creation are allowed in the underlying parser instance.

isAllowingInternalReaders

public boolean isAllowingInternalReaders()

Return true if internal readers creation are allowed in the underlying parser instance.

Returns:

true if internal readers creation are allowed in the underlying parser instance.

setEntityListResolver

public void setEntityListResolver(EntityListResolver resolver)

Set the EntityListResolver which can manage entity resolution in XML files.

Parameters:

resolver - the resolver

getEntityListResolver

public EntityListResolver getEntityListResolver()

Return the EntityListResolver which can manage entity resolution in XML files.

Returns:

the resolver

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set an error handler wich will be fired for parsing errors detected by the underlying parser.

Parameters:

errorHandler - the error handler

getErrorHandler

public ErrorHandler getErrorHandler()

Return the error handler wich will be fired for parsing errors detected by the underlying parser. null by default.

Returns:

the error handler

resetConfiguration

public void resetConfiguration()

Reset the configuration of the underlying parser (reatures and properties).

setFeature

public void setFeature(String name,
                       boolean value)

Set a underlying parser factory feature.

Parameters:

name - the feature name

value - the feature value

getFeatures

public Map<String,Boolean> getFeatures()

Return the underlying parser factory features.

Returns:

the features

setProperty

public void setProperty(String name,
                        Object value)

Set an underlying parser property.

Parameters:

name - the property name

value - the property value

getProperties

public Map<String,Object> getProperties()

Return the underlying parser properties.

Returns:

the properties

search

public List<XMLNode> search(XMLNode node,
                            String name,
                            boolean deep)

Search for the children nodes having a specified name.

Example

Suppose we have this XML file:

 <root desc="example">
   <element1 name="first" id="theID">
     <element2 name="second">
       <element3 name="fourth" />
       <element2 name="fith"/>
     </element2>
     <element3 name="third" />
   </element1>
 </root>
 

Then:

• If we execute search(root, "element2", false), the method will return one node, which is the first "element2" child
• If we execute search(root, "element2", true), the method will return two nodeq, which is the two "element2" children

Qualified name

If the name contains a colon, it will be considered as a qualified name with a prefix and a null URI. For example search(root, "h:element", false) is equivalent to search(root, new QName(XMLConstants.NULL_NS_URI, "element", "h"), false)

Parameters:

node - the root node

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public List<XMLNode> searchForNames(XMLNode node,
                                    List<String> names,
                                    boolean deep)

Search for the children nodes having a specified name among a list of names.

Parameters:

node - the root node

names - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public List<XMLNode> searchForNames(XMLNode node,
                                    String[] names,
                                    boolean deep)

Search for the children nodes having a specified name among a list of names.

Parameters:

node - the root node

names - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public XMLNode searchFirst(XMLNode node,
                           QName qname,
                           boolean deep)

Search for the first child node having a specified qualified name.

Parameters:

node - the root node

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public XMLNode searchFirst(XMLNode node,
                           List<QName> qnames,
                           boolean deep)

Search for the first child node having a specified qualified name among a list of qualified names.

Parameters:

node - the root node

qnames - the qualified qnames to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public XMLNode searchFirst(XMLNode node,
                           QName[] qnames,
                           boolean deep)

Search for the first child node having a specified qualified name among a list of qualified names.

Parameters:

node - the root node

qnames - the qualified qnames to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified qualified name

searchFirst

public XMLNode searchFirst(XMLNode node,
                           String name,
                           boolean deep)

Search for the first child node having a specified name.

Example

Suppose we have this XML file:

 <root desc="example">
   <element1 name="first" id="theID">
     <element2 name="second">
       <element3 name="fourth" />
       <element2 name="fith"/>
     </element2>
     <element3 name="third" />
   </element1>
 </root>
 

Then:

• If we execute searchFirst(root, "element2", false), the method will return one node, which is the first "element2" child
• If we execute searchFirst(root, "element2", true), the method will also return one node, which is the first "element2" child

Qualified name

If the name contains a colon, it will be considered as a qualified name with a prefix and a null URI. For example search(root, "h:element", false) is equivalent to searchFirst(root, new QName(XMLConstants.NULL_NS_URI, "element", "h"), false)

Parameters:

node - the root node

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

searchFirstForNames

public XMLNode searchFirstForNames(XMLNode node,
                                   List<String> names,
                                   boolean deep)

Search for the first child node having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

searchFirstForNames

public XMLNode searchFirstForNames(XMLNode node,
                                   String[] names,
                                   boolean deep)

Search for the first child node having a specified name among a list of names.

Parameters:

node - the root node

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the first child node with the specified name

search

public List<XMLNode> search(XMLNode node,
                            QName qname,
                            boolean deep)

Search for the children nodes having a specified qualified name.

Parameters:

node - the root node

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public List<XMLNode> search(XMLNode node,
                            List<QName> qnames,
                            boolean deep)

Search for the children nodes having a specified qualified name among a list of names.

Parameters:

node - the root node

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public List<XMLNode> search(XMLNode node,
                            QName[] qnames,
                            boolean deep)

Search for the children nodes having a specified qualified name among a list of names.

Parameters:

node - the root node

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

getNode

public XMLNode getNode(String str)

Return the Node from a String.

Parameters:

str - the String

Returns:

the node

getNode

public XMLNode getNode(Reader reader)

Return the Node from a Reader.

Parameters:

reader - the Reader

Returns:

the node

getNode

public XMLNode getNode(File file)

Return the Node from a file.

Parameters:

file - the file

Returns:

the root node

getNode

public XMLNode getNode(URL xmlURL)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

Returns:

the root node

getNode

public XMLNode getNode(URL xmlURL,
                       String comment)

Return the root Node from an XML URL, with a comment.

Parameters:

xmlURL - the XML URL

comment - the comment

Returns:

the root node

getRootNode

public XMLRoot getRootNode(String str)

Return the root Node from a String.

Parameters:

str - the String

Returns:

the root node

getRootNode

public XMLRoot getRootNode(File file)

Return the root Node from a file.

Parameters:

file - the file

Returns:

the root node

getRootNode

public XMLRoot getRootNode(Reader reader)

Return the root Node from a Reader.

Parameters:

reader - the Reader

Returns:

the root node

getRootNode

public XMLRoot getRootNode(URL xmlURL)

Return the root Node from an XML URL.

Parameters:

xmlURL - the XML URL

Returns:

the root node

print

public void print(XMLNode node,
                  int indentation,
                  File outputFile)
           throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputFile - the output file

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  boolean isOrdered,
                  File outputFile)
           throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

outputFile - the output file

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  boolean isOrdered,
                  NodeSerializer serializer,
                  File outputFile)
           throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

serializer - the node serializer

outputFile - the output file

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  File outputFile,
                  String encoding)
           throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputFile - the output file

encoding - the encoding (can be null)

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  File outputFile,
                  boolean isOrdered,
                  NodeSerializer serializer,
                  String encoding)
           throws IOException

Save in a File the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputFile - the output file

isOrdered - true if the order of attributes is preserved

serializer - the node serializer

encoding - the encoding (can be null)

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  URL outputURL)
           throws IOException

Save in an URL the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

outputURL - the output URL

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  boolean isOrdered,
                  URL outputURL)
           throws IOException

Save in an URL the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

outputURL - the output URL

Throws:

IOException

print

public void print(XMLNode node,
                  int indentation,
                  boolean isOrdered,
                  NodeSerializer serializer,
                  URL outputURL)
           throws IOException

Save in an URL the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

serializer - the node serailizer

outputURL - the output URL

Throws:

IOException

print

public String print(XMLNode node,
                    int indentation)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

Returns:

the String

print

public String print(XMLNode node,
                    int indentation,
                    boolean isOrdered,
                    NodeSerializer serializer)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

serializer - the node serializer

Returns:

the String

print

public String print(XMLNode node,
                    int indentation,
                    String encoding)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

encoding - the encoding (vcan be null)

Returns:

the String

print

public String print(XMLNode node,
                    int indentation,
                    boolean isOrdered,
                    NodeSerializer serializer,
                    String encoding)

Print as a String the content of an XML file under a root Node.

Parameters:

node - the root node

indentation - the indentation for the XML file for each child node

isOrdered - true if the order of attributes is preserved

serializer - the node serialier

encoding - the encoding (vcan be null)

Returns:

the String