org.apache.ddlutils.task
Class WriteSchemaToFileCommand

java.lang.Object
  extended by org.apache.ddlutils.task.Command
      extended by org.apache.ddlutils.task.WriteSchemaToFileCommand

public class WriteSchemaToFileCommand
extends Command

Reads the schema of the live database (as specified in the enclosing task), and writes it as XML to a file.

Version:
$Revision: 289996 $

Field Summary
 
Fields inherited from class org.apache.ddlutils.task.Command
_log
 
Constructor Summary
WriteSchemaToFileCommand()
           
 
Method Summary
 void execute(DatabaseTaskBase task, Database model)
          Executes this command.
 boolean isRequiringModel()
          Specifies whether this command requires a model, i.e.
 void setOutputFile(File outputFile)
          Specifies the name of the file to write the schema XML to.
 
Methods inherited from class org.apache.ddlutils.task.Command
handleException, isFailOnError, setFailOnError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WriteSchemaToFileCommand

public WriteSchemaToFileCommand()
Method Detail

setOutputFile

public void setOutputFile(File outputFile)
Specifies the name of the file to write the schema XML to.

Parameters:
outputFile - The output file

isRequiringModel

public boolean isRequiringModel()
Specifies whether this command requires a model, i.e. whether the second argument in Command.execute(DatabaseTaskBase, Database) cannot be null.

Specified by:
isRequiringModel in class Command
Returns:
true if this command requires a model

execute

public void execute(DatabaseTaskBase task,
                    Database model)
             throws org.apache.tools.ant.BuildException
Executes this command.

Specified by:
execute in class Command
Parameters:
task - The executing task
model - The database model
Throws:
org.apache.tools.ant.BuildException


Copyright © 2005-2007 Apache Software Foundation. All Rights Reserved.