Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.enhydra.kelp.common.node
Class OtterProject  view OtterProject download OtterProject.java

java.lang.Object
  extended byorg.enhydra.kelp.common.node.OtterProject
All Implemented Interfaces:
OtterNode, PropertyKeys

public abstract class OtterProject
extends java.lang.Object
implements OtterNode

Class declaration


Field Summary
static int MAP_SCOPE_ALL
           
static int MAP_SCOPE_NONE
           
static int MAP_SCOPE_SELECTED
           
 
Fields inherited from interface org.enhydra.kelp.common.node.PropertyKeys
DEFAULT_CONTENT, DEPLOY_BUILD, DEPLOY_CONTENT_TYPES, DEPLOY_ECHO, DEPLOY_INPUT_FILTER, DEPLOY_OVERWRITE, DEPLOY_PATH_BOOTSTRAP, DEPLOY_PATH_INPUT, DEPLOY_PATH_RESOURCE, DEPLOY_PATH_ROOT, DEPLOY_STARTUP_JAVA, DEPLOY_STARTUP_RUN, DEPLOY_TABLE_FIND, DEPLOY_TABLE_LENGTH, DEPLOY_TABLE_REPLACE, DEPLOY_WEB_APP, NAME_AUTO_PACK, NAME_GENTO, NAME_LIBRARIES, NAME_RESOURCE_STATIC, NAME_SELECTED, NAME_WORKING_DIR, NAME_XMLC_CUSTOM, NAME_XMLC_OPTION_FILEPATH, NAME_XMLC_PARAMETERS, NAME_XMLC_TYPE, VALUE_ENHYDRA, XMLC_BUILD, XMLC_DOC_TYPES, XMLC_MAP_PACKAGE_FROM, XMLC_MAP_PACKAGE_LENGTH, XMLC_MAP_PACKAGE_TO, XMLC_MAP_SCOPE, XMLC_OUTPUT_FILENAME, XMLC_PRINT_ACCESSOR, XMLC_PRINT_DOC, XMLC_PRINT_DOM, XMLC_PRINT_PARSE, XMLC_VERBOSE
 
Constructor Summary
OtterProject()
           
 
Method Summary
abstract  void configureRunClass()
          Method declaration
abstract  OtterNode[] findNodesByType(java.lang.String[] extensions)
          Return all nodes that ends with an extension in the provided extension list.
abstract  OtterTextFileNode[] getAllDeploymentDescs()
          Return all web.xml nodes.
abstract  OtterDocumentNode[] getAllDocuments()
          Get all document nodes in the project.
abstract  OtterNode[] getAllInput()
          Get all templates contained in the input directory.
 OtterXMLCNode[] getAllXMLCNodes()
          Method declaration
abstract  java.lang.String getClassOutputPath()
          Method declaration
abstract  java.lang.String getClassPath()
          Method declaration
abstract  java.lang.String getCodeGenDefaultDestination()
           
 java.lang.String[] getContentTypes()
           
 java.lang.String getDeployBootstrapPath()
          Method declaration
 java.lang.String getDeployInputPath()
           
 java.lang.String getDeployResourcePath()
           
 java.lang.String getDeployRootPath()
           
 java.lang.String[] getDocTypes()
           
 java.lang.Throwable getException()
           
abstract  OtterTextFileNode getFirstPolicy()
          Find and return first .policy node found in project.
 java.lang.String getGenerateToDirectory()
          Method declaration
 int getMapScope()
           
abstract  java.lang.Object getNativeProject()
          Return the IDE implementation of the project node.
abstract  OtterNodeFactory getNodeFactory()
          Method declaration
 java.lang.String[] getNonDocumentContentTypes()
           
 java.lang.String getOutputFilename()
          Method declaration
 java.lang.String[][] getPackageMap()
          Method declaration
abstract  java.lang.String getProjectName()
          Method declaration
abstract  java.lang.String getProperty(java.lang.String property)
          Method declaration
 java.lang.String[][] getReplacementTable()
          Method declaration
abstract  java.lang.String getSourcePath()
          Method declaration
abstract  java.lang.String[] getSourcePathArray()
          Method declaration
 java.lang.String getSourcePathOf(OtterNode node)
          Method declaration
 int getVerifiedMapScope()
          Method declaration
abstract  java.lang.String getWorkingPath()
          Get working directory for project run.
 java.lang.String getXMLCOptionFilePath()
          Method declaration
 java.lang.String getXMLCParameters()
          Method declaration
abstract  boolean isDefaultProject()
           
 boolean isDeployBuild()
          Is deployment desired during project build.
 boolean isDeployEcho()
          Is processing shown during deployment.
 boolean isDeployInputFilter()
          Method declaration
 boolean isDeployOverwrite()
          Method declaration
 boolean isDeployStartupJava()
          Method declaration
 boolean isDeployStartupRun()
          Method declaration
abstract  boolean isOpenBuild()
          Does IDE allow for integrated build.
 boolean isPrintAccessorInfo()
          Method declaration
 boolean isPrintDocumentInfo()
          Method declaration
 boolean isPrintDOM()
          Method declaration
 boolean isPrintParseInfo()
          Method declaration
 boolean isSelected()
           
 boolean isVerbose()
          Method declaration
 boolean isWebApplication()
          Method declaration
 boolean isXMLCBuild()
          Method declaration
private  boolean readBooleanProperty(java.lang.String property, boolean def)
          Method declaration
abstract  void setClassOutputPath(java.lang.String p)
           
 void setContentTypes(java.lang.String[] exts)
           
 void setDeployBootstrapPath(java.lang.String path)
          Method declaration
 void setDeployBuild(boolean b)
          Set if deployment is desired during project build.
 void setDeployEcho(boolean b)
          Set if processing should be shown during deployment.
 void setDeployInputFilter(boolean b)
          Method declaration
 void setDeployInputPath(java.lang.String path)
           
 void setDeployOverwrite(boolean b)
          Method declaration
 void setDeployResourcePath(java.lang.String path)
           
 void setDeployRootPath(java.lang.String path)
           
 void setDeployStartupJava(boolean b)
          Method declaration
 void setDeployStartupRun(boolean b)
          Method declaration
 void setDocTypes(java.lang.String[] exts)
           
 void setException(java.lang.Throwable e)
           
 void setMapScope(int i)
          Method declaration
 void setOutputFilename(java.lang.String n)
          Method declaration
 void setPackageMap(java.lang.String[][] map)
          Method declaration
 void setPrintAccessorInfo(boolean b)
          Method declaration
 void setPrintDocumentInfo(boolean b)
          Method declaration
 void setPrintDOM(boolean b)
          Method declaration
 void setPrintParseInfo(boolean b)
          Method declaration
abstract  void setProperty(java.lang.String property, int value)
          Method declaration
abstract  void setProperty(java.lang.String property, java.lang.String value)
          Method declaration
 void setReplacementTable(java.lang.String[][] table)
          Method declaration
 void setSelected(boolean b)
           
abstract  void setSourcePathArray(java.lang.String[] pathAsArray)
          Method declaration
 void setVerbose(boolean b)
          Method declaration
 void setWebApplication(boolean b)
          Method declaration
abstract  void setWorkingPath(java.lang.String path)
          Set working directory for project run.
 void setXMLCBuild(boolean b)
          Method declaration
 void setXMLCOptionFilePath(java.lang.String filename)
          Method declaration
 void setXMLCParameters(java.lang.String p)
          Method declaration
private  void writeBooleanProperty(java.lang.String property, boolean b)
          Method declaration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.enhydra.kelp.common.node.OtterNode
getFilePath, getNativeNode, getParent, getProject, save, setNativeNode
 

Field Detail

MAP_SCOPE_ALL

public static final int MAP_SCOPE_ALL
See Also:
Constant Field Values

MAP_SCOPE_SELECTED

public static final int MAP_SCOPE_SELECTED
See Also:
Constant Field Values

MAP_SCOPE_NONE

public static final int MAP_SCOPE_NONE
See Also:
Constant Field Values
Constructor Detail

OtterProject

public OtterProject()
Method Detail

getDocTypes

public java.lang.String[] getDocTypes()

setDocTypes

public void setDocTypes(java.lang.String[] exts)

getNonDocumentContentTypes

public java.lang.String[] getNonDocumentContentTypes()

getContentTypes

public java.lang.String[] getContentTypes()

setContentTypes

public void setContentTypes(java.lang.String[] exts)

getCodeGenDefaultDestination

public abstract java.lang.String getCodeGenDefaultDestination()

getFirstPolicy

public abstract OtterTextFileNode getFirstPolicy()
Find and return first .policy node found in project.


getWorkingPath

public abstract java.lang.String getWorkingPath()
Get working directory for project run.


setWorkingPath

public abstract void setWorkingPath(java.lang.String path)
Set working directory for project run.


getAllDeploymentDescs

public abstract OtterTextFileNode[] getAllDeploymentDescs()
Return all web.xml nodes.


findNodesByType

public abstract OtterNode[] findNodesByType(java.lang.String[] extensions)
Return all nodes that ends with an extension in the provided extension list.


getAllInput

public abstract OtterNode[] getAllInput()
Get all templates contained in the input directory.


getAllDocuments

public abstract OtterDocumentNode[] getAllDocuments()
Get all document nodes in the project.


getNativeProject

public abstract java.lang.Object getNativeProject()
Return the IDE implementation of the project node.


getProjectName

public abstract java.lang.String getProjectName()
Method declaration


isOpenBuild

public abstract boolean isOpenBuild()
Does IDE allow for integrated build.


getClassOutputPath

public abstract java.lang.String getClassOutputPath()
Method declaration


setClassOutputPath

public abstract void setClassOutputPath(java.lang.String p)

isDefaultProject

public abstract boolean isDefaultProject()

getSourcePath

public abstract java.lang.String getSourcePath()
Method declaration


getSourcePathArray

public abstract java.lang.String[] getSourcePathArray()
Method declaration


setSourcePathArray

public abstract void setSourcePathArray(java.lang.String[] pathAsArray)
Method declaration


getClassPath

public abstract java.lang.String getClassPath()
Method declaration


getProperty

public abstract java.lang.String getProperty(java.lang.String property)
Method declaration

Specified by:
getProperty in interface OtterNode

getNodeFactory

public abstract OtterNodeFactory getNodeFactory()
Method declaration


configureRunClass

public abstract void configureRunClass()
Method declaration


setProperty

public abstract void setProperty(java.lang.String property,
                                 java.lang.String value)
Method declaration

Specified by:
setProperty in interface OtterNode

setProperty

public abstract void setProperty(java.lang.String property,
                                 int value)
Method declaration

Specified by:
setProperty in interface OtterNode

getAllXMLCNodes

public OtterXMLCNode[] getAllXMLCNodes()
Method declaration


getXMLCOptionFilePath

public java.lang.String getXMLCOptionFilePath()
Method declaration

Specified by:
getXMLCOptionFilePath in interface OtterNode

setXMLCOptionFilePath

public void setXMLCOptionFilePath(java.lang.String filename)
Method declaration

Specified by:
setXMLCOptionFilePath in interface OtterNode

getXMLCParameters

public java.lang.String getXMLCParameters()
Method declaration

Specified by:
getXMLCParameters in interface OtterNode

setXMLCParameters

public void setXMLCParameters(java.lang.String p)
Method declaration

Specified by:
setXMLCParameters in interface OtterNode

isPrintDOM

public boolean isPrintDOM()
Method declaration


setPrintDOM

public void setPrintDOM(boolean b)
Method declaration


isXMLCBuild

public boolean isXMLCBuild()
Method declaration


setXMLCBuild

public void setXMLCBuild(boolean b)
Method declaration


isWebApplication

public boolean isWebApplication()
Method declaration


setWebApplication

public void setWebApplication(boolean b)
Method declaration


getDeployResourcePath

public java.lang.String getDeployResourcePath()

setDeployResourcePath

public void setDeployResourcePath(java.lang.String path)

getDeployRootPath

public java.lang.String getDeployRootPath()

setDeployRootPath

public void setDeployRootPath(java.lang.String path)

getDeployInputPath

public java.lang.String getDeployInputPath()

setDeployInputPath

public void setDeployInputPath(java.lang.String path)

isPrintParseInfo

public boolean isPrintParseInfo()
Method declaration


setPrintParseInfo

public void setPrintParseInfo(boolean b)
Method declaration


isPrintAccessorInfo

public boolean isPrintAccessorInfo()
Method declaration


setPrintAccessorInfo

public void setPrintAccessorInfo(boolean b)
Method declaration


isPrintDocumentInfo

public boolean isPrintDocumentInfo()
Method declaration


setPrintDocumentInfo

public void setPrintDocumentInfo(boolean b)
Method declaration


isVerbose

public boolean isVerbose()
Method declaration


setVerbose

public void setVerbose(boolean b)
Method declaration


getVerifiedMapScope

public int getVerifiedMapScope()
Method declaration


getMapScope

public int getMapScope()

setMapScope

public void setMapScope(int i)
Method declaration


getOutputFilename

public java.lang.String getOutputFilename()
Method declaration


setOutputFilename

public void setOutputFilename(java.lang.String n)
Method declaration


getPackageMap

public java.lang.String[][] getPackageMap()
Method declaration


setPackageMap

public void setPackageMap(java.lang.String[][] map)
Method declaration


getReplacementTable

public java.lang.String[][] getReplacementTable()
Method declaration


setReplacementTable

public void setReplacementTable(java.lang.String[][] table)
Method declaration


getGenerateToDirectory

public java.lang.String getGenerateToDirectory()
Method declaration


isDeployOverwrite

public boolean isDeployOverwrite()
Method declaration


setDeployOverwrite

public void setDeployOverwrite(boolean b)
Method declaration


isDeployInputFilter

public boolean isDeployInputFilter()
Method declaration


setDeployInputFilter

public void setDeployInputFilter(boolean b)
Method declaration


isDeployStartupRun

public boolean isDeployStartupRun()
Method declaration


setDeployStartupRun

public void setDeployStartupRun(boolean b)
Method declaration


isDeployStartupJava

public boolean isDeployStartupJava()
Method declaration


setDeployStartupJava

public void setDeployStartupJava(boolean b)
Method declaration


getDeployBootstrapPath

public java.lang.String getDeployBootstrapPath()
Method declaration


setDeployBootstrapPath

public void setDeployBootstrapPath(java.lang.String path)
Method declaration


isDeployBuild

public boolean isDeployBuild()
Is deployment desired during project build.


setDeployBuild

public void setDeployBuild(boolean b)
Set if deployment is desired during project build.


isDeployEcho

public boolean isDeployEcho()
Is processing shown during deployment.


setDeployEcho

public void setDeployEcho(boolean b)
Set if processing should be shown during deployment.


getSourcePathOf

public java.lang.String getSourcePathOf(OtterNode node)
Method declaration


writeBooleanProperty

private void writeBooleanProperty(java.lang.String property,
                                  boolean b)
Method declaration


readBooleanProperty

private boolean readBooleanProperty(java.lang.String property,
                                    boolean def)
Method declaration


isSelected

public boolean isSelected()
Specified by:
isSelected in interface OtterNode

setSelected

public void setSelected(boolean b)
Specified by:
setSelected in interface OtterNode

setException

public void setException(java.lang.Throwable e)
Specified by:
setException in interface OtterNode

getException

public java.lang.Throwable getException()
Specified by:
getException in interface OtterNode