org.apache.ibatis.ibator.api
Class GeneratedXmlFile

java.lang.Object
  extended by org.apache.ibatis.ibator.api.GeneratedFile
      extended by org.apache.ibatis.ibator.api.GeneratedXmlFile

public class GeneratedXmlFile
extends GeneratedFile

Author:
Jeff Butler

Constructor Summary
GeneratedXmlFile(Document document, java.lang.String fileName, java.lang.String targetPackage, java.lang.String targetProject, boolean isMergeable)
           
 
Method Summary
 java.lang.String getFileName()
          Get the file name (without any path).
 java.lang.String getFormattedContent()
          This method returns the entire contents of the generated file.
 java.lang.String getTargetPackage()
          Get the target package for the file.
 boolean isMergeable()
           
 
Methods inherited from class org.apache.ibatis.ibator.api.GeneratedFile
getTargetProject, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GeneratedXmlFile

public GeneratedXmlFile(Document document,
                        java.lang.String fileName,
                        java.lang.String targetPackage,
                        java.lang.String targetProject,
                        boolean isMergeable)
Parameters:
document -
fileName -
targetPackage -
targetProject -
isMergeable - true if the file can be merged by the built in XML file merger. Files are mergeable if all mergeable elements contain id's with the "ibatorgenerated_" prefix.
Method Detail

getFormattedContent

public java.lang.String getFormattedContent()
Description copied from class: GeneratedFile
This method returns the entire contents of the generated file. Clients can simply save the value returned from this method as the file contents. Subclasses such as @see org.apache.ibatis.ibator.api.GeneratedJavaFile offer more fine grained access to file parts, but still implement this method in the event that the entire contents are desired.

Specified by:
getFormattedContent in class GeneratedFile
Returns:
Returns the content.

getFileName

public java.lang.String getFileName()
Description copied from class: GeneratedFile
Get the file name (without any path). Clients should use this method to determine how to save the results.

Specified by:
getFileName in class GeneratedFile
Returns:
Returns the fileName.

getTargetPackage

public java.lang.String getTargetPackage()
Description copied from class: GeneratedFile
Get the target package for the file. Clients should use this method to determine how to save the results.

Specified by:
getTargetPackage in class GeneratedFile
Returns:
Returns the targetPackage.

isMergeable

public boolean isMergeable()
Specified by:
isMergeable in class GeneratedFile