atg.rview
Class DefinitionFileHandler

java.lang.Object
  atg.rview.DefinitionFileHandler

public class DefinitionFileHandler
extends java.lang.Object

This class contains a set of static methods that allow relational view definition files to be manipulated programmatically (that is, without creating an actual text version of the definition file).

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

DefinitionFileHandler()

Method Summary

static DefinitionFile	combineDefinitionFiles(DefinitionFile[] pFiles) Returns a new DefinitionFile containing the RelationalViewDefinitions and ResultSetProcessorDefinitions found in the given definition files.
static void	main(java.lang.String[] pArgs)
static DefinitionFile	parseDefinitionFile(java.io.File pFile) Parses a DefinitionFile from the given File
static DefinitionFile	parseDefinitionFile(java.io.InputStream pIn) Parses a DefinitionFile from the given input stream
static DefinitionFile	parseXMLDefinitionFile(java.io.File pFile) Parses a DefinitionFile from the given XML-formatted file
static DefinitionFile	parseXMLDefinitionFile(java.io.InputStream pIn) Parses a DefinitionFile from the given XML-formatted file
static void	printDefinitionFile(DefinitionFile pFile, java.io.PrintStream pOut) Prints the specified DefinitionFile to the specified PrintStream in text form.
static void	printXMLDefinitionFile(DefinitionFile pFile, java.io.PrintStream pOut) Prints the specified DefinitionFile to the specified PrintStream in text form using the XML format.
static java.lang.String[]	verifyDefinitionFile(DefinitionFile pFile) Checks a definition file for semantic problems, and returns an array of the problems that it finds, where each element of the array is a separate problem.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

DefinitionFileHandler

public DefinitionFileHandler()

Method Detail

parseDefinitionFile

public static DefinitionFile parseDefinitionFile(java.io.InputStream pIn)
                                          throws RelationalViewException

Parses a DefinitionFile from the given input stream

Throws:

RelationalViewException

parseDefinitionFile

public static DefinitionFile parseDefinitionFile(java.io.File pFile)
                                          throws RelationalViewException,
                                                 java.io.IOException

Parses a DefinitionFile from the given File

Throws:

RelationalViewException

java.io.IOException

parseXMLDefinitionFile

public static DefinitionFile parseXMLDefinitionFile(java.io.InputStream pIn)
                                             throws RelationalViewException,
                                                    java.io.IOException

Parses a DefinitionFile from the given XML-formatted file

Throws:

RelationalViewException

java.io.IOException

parseXMLDefinitionFile

public static DefinitionFile parseXMLDefinitionFile(java.io.File pFile)
                                             throws RelationalViewException,
                                                    java.io.IOException

Parses a DefinitionFile from the given XML-formatted file

Throws:

RelationalViewException

java.io.IOException

combineDefinitionFiles

public static DefinitionFile combineDefinitionFiles(DefinitionFile[] pFiles)

Returns a new DefinitionFile containing the RelationalViewDefinitions and ResultSetProcessorDefinitions found in the given definition files. This can be used to combine several parsed files into a single relational view definition.

printXMLDefinitionFile

public static void printXMLDefinitionFile(DefinitionFile pFile,
                                          java.io.PrintStream pOut)

Prints the specified DefinitionFile to the specified PrintStream in text form using the XML format. The printed version can later be parsed to produce an identical DefinitionFile.

printDefinitionFile

public static void printDefinitionFile(DefinitionFile pFile,
                                       java.io.PrintStream pOut)

Prints the specified DefinitionFile to the specified PrintStream in text form. The printed version can later be parsed to produce an identical DefinitionFile.

verifyDefinitionFile

public static java.lang.String[] verifyDefinitionFile(DefinitionFile pFile)

Checks a definition file for semantic problems, and returns an array of the problems that it finds, where each element of the array is a separate problem. If no problems are found, then a zero-length array is returned.

main

public static void main(java.lang.String[] pArgs)
                 throws RelationalViewException

Throws:

RelationalViewException