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

Quick Search    Search Deep

org.scopemvc.application.timewarp.source
Class ScopeSource  view ScopeSource download ScopeSource.java

java.lang.Object
  extended byorg.scopemvc.application.timewarp.source.ScopeSource
All Implemented Interfaces:
FileProducer
Direct Known Subclasses:
ScopeSourceItem, ScopeTestSource

public class ScopeSource
extends java.lang.Object
implements FileProducer

Base class for classes writing specific Scope components.

Version:
2.0

Field Summary
private  boolean enabled
           
private  org.scopemvc.application.timewarp.CodeGeneratorModel model
           
private  java.lang.String suffix
           
private  java.lang.String template
           
 
Constructor Summary
ScopeSource(org.scopemvc.application.timewarp.CodeGeneratorModel model, java.lang.String suffix, java.lang.String template)
          Constructor for the ScopeSource object
 
Method Summary
 org.apache.velocity.VelocityContext createVelocityContext()
          Returns a VelocityContext object which will be used for file generation.
 java.lang.String getBaseClassName()
          Gets the base class name
 java.lang.String getDestinationClassName()
          Gets the destination class name
 java.io.File getDestinationDir()
          Gets the DestinationDir attribute of the FileProducer object
 java.lang.String getDestinationFileName()
          Gets the destination file name
 java.lang.String getDestinationFileName(java.lang.String prefix, java.lang.String suffix)
          Gets the destination file name
protected  org.scopemvc.application.timewarp.CodeGeneratorModel getModel()
          Gets the model
 java.lang.String getPackage()
          Gets the package
 java.lang.String getSuffix()
          Gets the suffix
 java.net.URL getTemplate()
          Gets the Template attribute of the FileProducer object
 boolean isEnabled()
          Return true if this file producer is enabled and can generate code
 void setEnabled(boolean value)
          Sets the enabled
 void setSuffix(java.lang.String value)
          Sets the suffix
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

model

private org.scopemvc.application.timewarp.CodeGeneratorModel model

suffix

private java.lang.String suffix

enabled

private boolean enabled

template

private java.lang.String template
Constructor Detail

ScopeSource

public ScopeSource(org.scopemvc.application.timewarp.CodeGeneratorModel model,
                   java.lang.String suffix,
                   java.lang.String template)
Constructor for the ScopeSource object

Method Detail

getDestinationDir

public java.io.File getDestinationDir()
Gets the DestinationDir attribute of the FileProducer object

Specified by:
getDestinationDir in interface FileProducer

getBaseClassName

public java.lang.String getBaseClassName()
Gets the base class name


getSuffix

public java.lang.String getSuffix()
Gets the suffix


getDestinationClassName

public java.lang.String getDestinationClassName()
Gets the destination class name


getDestinationFileName

public java.lang.String getDestinationFileName()
Gets the destination file name

Specified by:
getDestinationFileName in interface FileProducer

getDestinationFileName

public java.lang.String getDestinationFileName(java.lang.String prefix,
                                               java.lang.String suffix)
Gets the destination file name


getPackage

public java.lang.String getPackage()
Gets the package


getTemplate

public java.net.URL getTemplate()
Gets the Template attribute of the FileProducer object

Specified by:
getTemplate in interface FileProducer

isEnabled

public boolean isEnabled()
Return true if this file producer is enabled and can generate code

Specified by:
isEnabled in interface FileProducer

setEnabled

public void setEnabled(boolean value)
Sets the enabled

Specified by:
setEnabled in interface FileProducer

setSuffix

public void setSuffix(java.lang.String value)
Sets the suffix


createVelocityContext

public org.apache.velocity.VelocityContext createVelocityContext()
Returns a VelocityContext object which will be used for file generation. This object can contain objects that are bound to names and can be accessed from the template.

Specified by:
createVelocityContext in interface FileProducer

getModel

protected org.scopemvc.application.timewarp.CodeGeneratorModel getModel()
Gets the model