Java Doc for Channel.java in  » Database-ORM » transformica-2.3.0 » biz » hammurapi » transformica » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database ORM » transformica 2.3.0 » biz.hammurapi.transformica 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   biz.hammurapi.transformica.Channel

All known Subclasses:   biz.hammurapi.transformica.bnf.BnfChannel,  biz.hammurapi.transformica.jdbc.SchemaChannel,  biz.hammurapi.transformica.jdbc.TableChannel,
Channel
public class Channel implements PoliteVisitor(Code)
Transformation channel. Matches UML elements by type, stereotype and generation language. One UML element can match more than one channel.
author:
   Pavel Vlasov
version:
   $Revision: 1.1 $


Field Summary
final public static  SetRESERVED_NAMES
    
protected  Listchannels
    
protected  Channelparent
    
protected  TransformSessionsession
    

Constructor Summary
public  Channel(TransformSession session)
    

Method Summary
public  voidaddConfiguredAcceptor(AcceptorEntry entry)
     Model element acceptor.
public  voidaddConfiguredContextEntry(ContextObjectEntry entry)
     Context entry which will be available in templates.
public  voidaddConfiguredFileTouchDetector(FileTouchDetectorFactory ftsrf)
     File info file.
public  voidaddConfiguredJdbcTouchDetector(HypersonicTouchDetectorFactory jtsrf)
     JDBC file info repository.
public  ChannelcreateChannel()
     Nested transformation channel.
public  voiddestroy()
    
public  StringgenerateFileName(Object element)
    
public  CompositeAcceptorgetCompositeAcceptor()
    
protected  ConsumergetConsumer()
     Override this method to route output to custom destination.
public  MapgetContextEntries()
    
public  StringgetFileNameTemplate()
    
public  StringgetName()
    
static  StringgetObjectIdString(Object o)
    
public  FilegetOutputDir()
    
 TemplategetTemplate()
    
 TouchDetectorgetTouchDetector()
    
 Stringinclude(Object element)
     Generates channel to String for inclusion to another template.
public  voidinit()
    
public  booleanisForce()
    
protected  booleanisHidden()
    
public  booleanisOverride()
    
public  voidleave(Object element)
    
public  voidprocess(Object element, Writer writer)
    
public  voidprocess(Object element)
    
public  voidsetAppend(boolean append)
    
public  voidsetConditionExpression(String conditionExpression)
     Condition XPath expression.
public  voidsetFileNameTemplate(String fileNameTemplate)
     File name template.
public  voidsetForce(boolean force)
     Force generation.
public  voidsetHidden(boolean hidden)
     Indicates that this channel is invisible for a visitor.
public  voidsetIteratorExpression(String iteratorExpression)
     Iterator XPath expression.
public  voidsetLeaveChannel(boolean isLeaveChannel)
     If true then template processing happens in "leave" method instead of "visit" method.
public  voidsetName(String name)
     Channel name.
public  voidsetOutputDir(File outputDir)
    
public  voidsetOverride(boolean override)
     Do not process this channel if model element has already been processed by another channel.
public  voidsetTemplate(String template)
     Template name.
public static  voidvalidateEntryName(String name)
    
public  booleanvisit(Object element)
    

Field Detail
RESERVED_NAMES
final public static Set RESERVED_NAMES(Code)



channels
protected List channels(Code)



parent
protected Channel parent(Code)



session
protected TransformSession session(Code)




Constructor Detail
Channel
public Channel(TransformSession session)(Code)

Parameters:
  task -




Method Detail
addConfiguredAcceptor
public void addConfiguredAcceptor(AcceptorEntry entry) throws BuildException(Code)
Model element acceptor.
Parameters:
  param -
throws:
  BuildException -



addConfiguredContextEntry
public void addConfiguredContextEntry(ContextObjectEntry entry) throws BuildException(Code)
Context entry which will be available in templates. Overrides entry with the same name defined at task level.
Parameters:
  param -
throws:
  BuildException -



addConfiguredFileTouchDetector
public void addConfiguredFileTouchDetector(FileTouchDetectorFactory ftsrf) throws BuildException(Code)
File info file. Overrides setting at task level.
Parameters:
  ftsrf -
throws:
  BuildException -



addConfiguredJdbcTouchDetector
public void addConfiguredJdbcTouchDetector(HypersonicTouchDetectorFactory jtsrf) throws BuildException(Code)
JDBC file info repository. Overrides setting at task level.
Parameters:
  jtsrf -
throws:
  BuildException -



createChannel
public Channel createChannel()(Code)
Nested transformation channel. Nested channel inherits parent's context objects, applies only to model elements matched by the parent or below and matches only if parent matches and nested channel matches. Can be useful for, say, generating only classes from particular packages.



destroy
public void destroy() throws TransformicaException(Code)



generateFileName
public String generateFileName(Object element) throws TransformicaException(Code)



getCompositeAcceptor
public CompositeAcceptor getCompositeAcceptor()(Code)



getConsumer
protected Consumer getConsumer()(Code)
Override this method to route output to custom destination.



getContextEntries
public Map getContextEntries()(Code)



getFileNameTemplate
public String getFileNameTemplate()(Code)
File name template



getName
public String getName()(Code)



getObjectIdString
static String getObjectIdString(Object o)(Code)



getOutputDir
public File getOutputDir()(Code)



getTemplate
Template getTemplate() throws Exception(Code)



getTouchDetector
TouchDetector getTouchDetector()(Code)



include
String include(Object element) throws TransformicaException(Code)
Generates channel to String for inclusion to another template.
Parameters:
  element - @throwsTransformicaException



init
public void init() throws TransformicaException(Code)



isForce
public boolean isForce()(Code)



isHidden
protected boolean isHidden()(Code)



isOverride
public boolean isOverride()(Code)



leave
public void leave(Object element)(Code)



process
public void process(Object element, Writer writer) throws TransformicaException(Code)



process
public void process(Object element) throws TransformicaException(Code)
Processes and writes output to File
Parameters:
  modelElement -
throws:
  TransformicaException -



setAppend
public void setAppend(boolean append)(Code)
Set this to true to append to existing file instead of overwriting
Parameters:
  append -



setConditionExpression
public void setConditionExpression(String conditionExpression)(Code)
Condition XPath expression. Must evaluate to true for channel to match. This is a more advanced then matching by stereotype or element name and not that complicates as writing custom Acceptor class.
Parameters:
  stereotype -



setFileNameTemplate
public void setFileNameTemplate(String fileNameTemplate)(Code)
File name template. The template is evaluated by the same engine as the template, all context objects are available during evaluation.
Parameters:
  fileNameTemplate -



setForce
public void setForce(boolean force)(Code)
Force generation. Ignore timestamps.
Parameters:
  force -



setHidden
public void setHidden(boolean hidden)(Code)
Indicates that this channel is invisible for a visitor. Default is false. Set it to true if you want channels for include only.
Parameters:
  hidden -



setIteratorExpression
public void setIteratorExpression(String iteratorExpression)(Code)
Iterator XPath expression. If iteratorExpression is set then Channel doesn't process the matched element but applies XPath expression to the elment and processes results.
Parameters:
  iteratorExpression -



setLeaveChannel
public void setLeaveChannel(boolean isLeaveChannel)(Code)
If true then template processing happens in "leave" method instead of "visit" method.
Parameters:
  isLeaveChannel -



setName
public void setName(String name)(Code)
Channel name.
Parameters:
  name -



setOutputDir
public void setOutputDir(File outputDir) throws BuildException(Code)
Output directory
Parameters:
  outputDir -



setOverride
public void setOverride(boolean override)(Code)
Do not process this channel if model element has already been processed by another channel. Default is true.
Parameters:
  override -



setTemplate
public void setTemplate(String template)(Code)
Template name. If template name is not set then no generation will happen, but nested channels will be processed.
Parameters:
  template -



validateEntryName
public static void validateEntryName(String name) throws BuildException(Code)



visit
public boolean visit(Object element)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.