oracle.toplink.tools.workbench
Class XMLProjectReader

java.lang.Object
  |
  +--oracle.toplink.tools.workbench.XMLProjectReader

public class XMLProjectReader

extends java.lang.Object

Purpose: Allow for a TopLink Builder generated deployment XML project file to be read. The Builder XML file stores the TopLink descriptor (meta-data) information which describe the database mappings. This reader returns an instance of Project to be used to initialize a TopLink session.

Since:

TopLink 3.0

Constructor Summary

XMLProjectReader()

Method Summary

Type	Method
static Project	read(java.io.Reader reader) PUBLIC: Given a Reader on an XML database, and the name of a project, this returns a TopLink Project object.
static Project	read(java.lang.String fileName) PUBLIC: Given a path representing the directory of an XML database, and the name of a project, this returns a TopLink Project object.
static Project	read(java.lang.String projectFileName, java.lang.ClassLoader loader) PUBLIC: Given a File Name and a class loader, this returns a TopLink Project object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLProjectReader

public XMLProjectReader()

Method Detail

read

public static Project read(java.lang.String fileName)

PUBLIC: Given a path representing the directory of an XML database, and the name of a project, this returns a TopLink Project object. If the project is not found, or if there is more than one project in the database of that name, the method throws a BuilderException. Note: this method can only be used for 3.0 projects or later.

Parameters:

xmlDatabaseDirectory - path to directory containing the XML database

projectName - String the name of the project to load

read

public static Project read(java.io.Reader reader)

PUBLIC: Given a Reader on an XML database, and the name of a project, this returns a TopLink Project object. If the project is not found, or if there is more than one project in the database of that name, the method throws a BuilderException. Note: this method can only be used for 3.0 projects or later.

Parameters:

xmlDatabaseDirectory - path to directory containing the XML database

projectName - String the name of the project to load

read

public static Project read(java.lang.String projectFileName,
                           java.lang.ClassLoader loader)

PUBLIC: Given a File Name and a class loader, this returns a TopLink Project object. If the project is not found, or if there is more than one project in the database of that name, the method throws a BuilderException. Note: this method can only be used for 3.0 projects or later.