org.mdiutil.xml

Class XMLRootDetector

java.lang.Object

org.mdiutil.xml.XMLRootDetector

public class XMLRootDetector
extends Object

This class detect the root element ofr only its name name for an XML file. Note that the class makes a best effort to catch any internal exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
static short	INVALID The type for invalid result.
static short	INVALID_INPUT The type for invalid input result for the last invocation.
static short	NO_INPUT The type for no input result for the last invocation.
static short	RESULT_OK The type for correct result for the last invocation.

Constructor Summary

Constructors

Constructor and Description
XMLRootDetector()

Method Summary

Modifier and Type	Method and Description
boolean	checkRootName(File file, String rootName) Return true if the name of the root element of an XML file is the specified name.
boolean	checkRootName(Reader reader, String rootName) Return true if the name of the root element of a Reader parsed as an XML file is the specified name.
boolean	checkRootName(URL url, QName rootName) Return true if the qualified name of the root element of an XML URL is the specified qualified name.
boolean	checkRootName(URL url, String rootName) Return true if the name of the root element of an XML URL is the specified name.
boolean	checkRootQualifiedName(File file, QName rootName) Return true if the qualified name of the root element of an XML file is the specified qualified name.
boolean	checkRootQualifiedName(Reader reader, QName rootName) Return true if the qualified name of the root element of a Reader parsed as an XML file is the specified qualified name.
short	getLastResultType() Return the type of the last detection result.
QName	getQualifiedRootName(File file) Return the qualified name of the root element of an XML File.
QName	getQualifiedRootName(File file, boolean acceptNotWellFormed) Return the qualified name of the root element of an XML File.
QName	getQualifiedRootName(Reader reader) Return the qualified name of the root element of a Reader parsed as an XML file.
QName	getQualifiedRootName(URL url) Return the qualified name of the root element of an XML URL.
QName	getQualifiedRootName(URL url, boolean acceptNotWellFormed) Return the qualified name of the root element of an XML URL.
XMLNode	getRoot(File file) Return the root element of an XML File.
XMLNode	getRoot(File file, boolean acceptNotWellFormed) Return the root element of an XML File.
XMLNode	getRoot(Reader reader) Return the root element of a Reader parsed as an XML file.
XMLNode	getRoot(URL url) Return the root element of an XML URL.
XMLNode	getRoot(URL url, boolean acceptNotWellFormed) Return the root element of an XML URL.
String	getRootName(File file) Return the name of the root element of an XML File.
String	getRootName(File file, boolean acceptNotWellFormed) Return the name of the root element of an XML File.
String	getRootName(Reader reader) Return the name of the root element of a Reader parsed as an XML file.
String	getRootName(URL url) Return the name of the root element of an XML URL.
String	getRootName(URL url, boolean acceptNotWellFormed) Return the name of the root element of an XML URL.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID

public static final short INVALID

The type for invalid result. It will only have this type before the first invocation.

See Also:

Constant Field Values

RESULT_OK

public static final short RESULT_OK

The type for correct result for the last invocation.

See Also:

Constant Field Values

NO_INPUT

public static final short NO_INPUT

The type for no input result for the last invocation.

See Also:

Constant Field Values

INVALID_INPUT

public static final short INVALID_INPUT

The type for invalid input result for the last invocation.

See Also:

Constant Field Values

Constructor Detail

XMLRootDetector

public XMLRootDetector()

Method Detail

getLastResultType

public short getLastResultType()

Return the type of the last detection result. The values can be:

• INVALID: invalid result. It will only have this type before the first invocation.
• RESULT_OK: correct result
• INVALID_INPUT: invalid input (the input file is an invalid XML file)
• NO_INPUT: no input (the input file does not exist)

Returns:

he type of the last detection result

checkRootName

public boolean checkRootName(File file,
                             String rootName)

Return true if the name of the root element of an XML file is the specified name.

Parameters:

file - the file

rootName - the specified name of the root element to check

Returns:

true if the name of the root element of an XML file is the specified name

checkRootQualifiedName

public boolean checkRootQualifiedName(File file,
                                      QName rootName)

Return true if the qualified name of the root element of an XML file is the specified qualified name.

Parameters:

file - the file

rootName - the specified qualified name of the root element to check

Returns:

true if the qualified name of the root element of an XML file is the specified qualified name

checkRootName

public boolean checkRootName(Reader reader,
                             String rootName)

Return true if the name of the root element of a Reader parsed as an XML file is the specified name.

Parameters:

reader - the Reader

rootName - the specified name of the root element to check

Returns:

true if the name of the root element of an XML file is the specified name

checkRootQualifiedName

public boolean checkRootQualifiedName(Reader reader,
                                      QName rootName)

Return true if the qualified name of the root element of a Reader parsed as an XML file is the specified qualified name.

Parameters:

reader - the Reader

rootName - the specified qualified name of the root element to check

Returns:

true if the name of the root element of an XML file is the specified qualified name

checkRootName

public boolean checkRootName(URL url,
                             String rootName)

Return true if the name of the root element of an XML URL is the specified name.

Parameters:

url - the URL

rootName - the specified name of the root element to check

Returns:

true if the name of the root element of an XML file is the specified name

checkRootName

public boolean checkRootName(URL url,
                             QName rootName)

Return true if the qualified name of the root element of an XML URL is the specified qualified name.

Parameters:

url - the URL

rootName - the specified qualified name of the root element to check

Returns:

true if the qualified name of the root element of an XML file is the specified qualified name

getRoot

public XMLNode getRoot(Reader reader)

Return the root element of a Reader parsed as an XML file.

Parameters:

reader - the Reader

Returns:

the root element of the Reader parsed as an XML file

getRoot

public XMLNode getRoot(URL url)

Return the root element of an XML URL.

Parameters:

url - the URL

Returns:

the root element of an XML URL

getRoot

public XMLNode getRoot(URL url,
                       boolean acceptNotWellFormed)

Return the root element of an XML URL.

Parameters:

url - the URL

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the root element of an XML URL

getRoot

public XMLNode getRoot(File file)

Return the root element of an XML File.

Parameters:

file - the file

Returns:

the root element

getRoot

public XMLNode getRoot(File file,
                       boolean acceptNotWellFormed)

Return the root element of an XML File.

Parameters:

file - the file

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the root element

getRootName

public String getRootName(URL url)

Return the name of the root element of an XML URL.

Parameters:

url - the URL

Returns:

the name of the root element

getRootName

public String getRootName(URL url,
                          boolean acceptNotWellFormed)

Return the name of the root element of an XML URL.

Parameters:

url - the URL

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the name of the root element

getRootName

public String getRootName(Reader reader)

Return the name of the root element of a Reader parsed as an XML file.

Parameters:

reader - the Reader

Returns:

the name of the root element

getRootName

public String getRootName(File file)

Return the name of the root element of an XML File.

Parameters:

file - the file

Returns:

the name of the root element

getRootName

public String getRootName(File file,
                          boolean acceptNotWellFormed)

Return the name of the root element of an XML File.

Parameters:

file - the fil

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the name of the root element

getQualifiedRootName

public QName getQualifiedRootName(URL url)

Return the qualified name of the root element of an XML URL.

Parameters:

url - the URL

Returns:

the qualified name of the root element

getQualifiedRootName

public QName getQualifiedRootName(URL url,
                                  boolean acceptNotWellFormed)

Return the qualified name of the root element of an XML URL.

Parameters:

url - the URL

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the qualified name of the root element

getQualifiedRootName

public QName getQualifiedRootName(Reader reader)

Return the qualified name of the root element of a Reader parsed as an XML file.

Parameters:

reader - the Reader

Returns:

the qualified name of the root element

getQualifiedRootName

public QName getQualifiedRootName(File file)

Return the qualified name of the root element of an XML File.

Parameters:

file - the file

Returns:

the qualified name of the root element

getQualifiedRootName

public QName getQualifiedRootName(File file,
                                  boolean acceptNotWellFormed)

Return the qualified name of the root element of an XML File.

Parameters:

file - the file

acceptNotWellFormed - true if not well-formed XML files are accepted

Returns:

the qualified name of the root element