org.nexusformat.nxvalidate

Class ValidatorUtils

java.lang.Object

org.nexusformat.nxvalidate.ValidatorUtils

public class ValidatorUtils
extends java.lang.Object

A class the wraps the conversion and validation processes.

Constructor Summary

Constructors

Constructor and Description
ValidatorUtils(java.io.File nxsFile, java.lang.String nxconvertCommand)

Method Summary

Methods

Modifier and Type	Method and Description
void	doConversion(boolean convertNxs) Set a flag that indicates that the conversion of a NEXUS file to a reduced document should be performed (true).
java.io.File	getNXS() Get the File object pointing to the NEXUS file.
java.io.File	getReduced() Get the File object pointing to the reduced NEXUS file.
java.io.File	getSchematron() Get the File object pointing to the Schematron file that contains the rules for checking the reduced document.
void	setKeepTemp(boolean keepTemp) Set a flag that indicates that the temporary files (such as the reduced document and the validation results) should be kept (true).
void	setNXS(java.io.File nxsFile) Set the File object pointing to the NEXUS file.
void	setReduced(java.io.File reduced) Set the File object pointing to the reduced NEXUS file.
void	setSchematron(java.io.File schematronFile) Set the File object pointing to the Schematron file that contains the rules for checking the reduced document.
java.io.File	validate() This methods performs the validation using the NEXUS (or reduced) file and the Schematron file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatorUtils

public ValidatorUtils(java.io.File nxsFile,
              java.lang.String nxconvertCommand)

Method Detail

setReduced

public void setReduced(java.io.File reduced)

Set the File object pointing to the reduced NEXUS file.

Parameters:

reduced - the reduced NEXUS File object.

getReduced

public java.io.File getReduced()

Get the File object pointing to the reduced NEXUS file.

Returns:

the reduced NEXUS File object.

setNXS

public void setNXS(java.io.File nxsFile)

Set the File object pointing to the NEXUS file.

Parameters:

nxsFile - the NEXUS File object.

getNXS

public java.io.File getNXS()

Get the File object pointing to the NEXUS file.

Returns:

the NEXUS File object.

setSchematron

public void setSchematron(java.io.File schematronFile)

Set the File object pointing to the Schematron file that contains the rules for checking the reduced document.

Parameters:

schematronFile - the Schematron File object.

getSchematron

public java.io.File getSchematron()

Get the File object pointing to the Schematron file that contains the rules for checking the reduced document.

Returns:

the Schematron File object.

doConversion

public void doConversion(boolean convertNxs)

Set a flag that indicates that the conversion of a NEXUS file to a reduced document should be performed (true).

Parameters:

convertNxs - the conversion flag.

setKeepTemp

public void setKeepTemp(boolean keepTemp)

Set a flag that indicates that the temporary files (such as the reduced document and the validation results) should be kept (true).

Parameters:

keepTemp - the keep temp files flag.

validate

public java.io.File validate()
                      throws NXvalidateException

This methods performs the validation using the NEXUS (or reduced) file and the Schematron file. The returned file is the results file.

Returns:

the results file as a File object.

Throws:

NXvalidateException