ontomde-java-frontend 1.0.4

data/lib/ontomde-java-frontend/command.rdoc

@@ -0,0 +1,483 @@
+ontomde-java is a command line utility to generate Java Code from a UML2 model stored in a UML2/RDF model file.
+
+ This command line is a front end to OntoMDE generator offering a set of pre-packaged, yet powerfull generation rules.
+
+ This Java code generator is full featured and covers many UML features (incremental generation, loading of additional MDA transformation rules, ...)
+
+== Example: generate java code from one model file
+ $ ontomde-java --nt myUmlModel.emx.nt
+
+== Example: generate java code in a custom directory
+ $ ontomde-java --nt myUmlModel.emx.nt --target ./src
+
+== Usage:
+ ontomde-java [options]
+== Source and Target options :
+
+===-nt FILE1.nt,FILE2.nt, ... :
+
+ Source UML2 model(s) (exported from a UML case tool)
+ 
+
+<i>default:</i> --nt 
+
+===-ntList FILE1,FILE2,... :
+
+ File containing a list of nt file to be loaded
+===-l, --load FILE1.rb,File2.rb :
+
+ Optionnal ruby extension or setup file (used as well new datatype declaration mappings, as for any generation customisation)
+ 
+
+<i>default:</i> --load 
+===-loadDir DIRECTORY1,.. :
+
+ Optionnal ruby extension or setup file
+ (used as well new datatype declaration mappings, as for any generation customisation)
+ 
+
+<i>default:</i> --loadDir 
+===-loadList FILE_list1,FILE_list2, ... :
+
+ File containing a list of ruby file to be loaded
+ (same as --load on each item)
+===-javaRelativeDir DIRECTORY :
+
+ Relative destination directory for generated java files, properties, ...
+ relative to --targetDir
+ 
+
+<i>default:</i> --javaRelativeDir ./src/java/
+===-webResourcesDir DIRECTORY :
+
+ Relative destination directory for generated Web Resources properties, ...
+ relative to --targetDir
+ 
+
+<i>default:</i> --webResourcesDir ./src/java/
+===-javaFilePathRegexp REGEXP@DIRECTORY :
+
+ Relative destination directory for generated java files, properties, ...
+ relative to --targetDir
+ 
+
+<i>default:</i> --javaFilePathRegexp 
+===-targetDir DIRECTORY :
+
+ Target generation root directory
+ 
+
+<i>default:</i> --targetDir .
+== Model pre-processors options :
+
+===-[no-]withMultipleInheritance :
+
+ Apply pattern to map UML model with multiple inheritance to Java compliant model.
+ (Class inheritance is mapped to interface implementation)
+ 
+
+<i>default:</i> --withMultipleInheritance
+===-p, --[no-]withAutoImplementProperty :
+
+ Generate automatically missing property in concrete class implementing an interface uml properties
+ (feature introduced for model redondancy reduction)
+ 
+
+<i>default:</i> --no-withAutoImplementProperty
+===-o, --[no-]withAutoImplementOperation :
+
+ Generate automatically missing operations in concrete class implementing an interface
+ (feature introduced for model redondancy reduction)
+ 
+
+<i>default:</i> --no-withAutoImplementOperation
+===-[no-]makeCompositionBiNavigable :
+
+ Force compositions to be bi-navigable
+ (Feature introduced for web persistence handling)
+ 
+
+<i>default:</i> --no-makeCompositionBiNavigable
+== Model enhancement options:
+
+===-a, --[no-]withEnumAssignable :
+
+ Generates for each class and interfaces an enum containing assignable class
+ (required for creators)
+ NOTE: also disable generation of createAndAdd methods
+ 
+
+<i>default:</i> --withEnumAssignable
+===-enumAssignableSubPackage SUBDIR :
+
+ Directory where enumAssignable artefacts wil be generated
+ 
+
+<i>default:</i> --enumAssignableSubPackage assignable 
+===-f, --[no-]withGenerateMethodForm :
+
+ Apply a pattern to generate a form (as a class) for every method of the model.
+ (Feature introduced for web form handling)
+ 
+
+<i>default:</i> --no-withGenerateMethodForm
+== Pre-Java 5 compatibility options:
+===-e, --[no-]withEnumAsString :
+
+ Generate additional string getter and setter
+ for properties with an enum type, so enums property can be manipulated as if it was a string
+ (feature introduced
+ for Flex interoperability)
+ 
+
+<i>default:</i> --no-withEnumAsString
+
+== Tests Data options:
+
+===-updateKB :
+
+ Create or update protege 2000 knowledge base project (for creating tests data and junit tests bases on use cases.)
+ 
+
+<i>default:</i> --no-updateKB
+===-kbTargetfile FILENAME _WITHOUT_EXTENSION :
+
+ Protege data test file to be generated or update.
+ This generates a protege/2000 project file to be used for editing tests data attached to test instances.
+ 
+
+<i>default:</i> --kbTargetfile defaultKbTargetFile
+===-[no-]excludeNonTestFiles :
+
+ Do not generate files which are not test files
+ junit,data,...
+ 
+
+<i>default:</i> --no-excludeNonTestFiles
+===-[no-]includeTestFiles :
+
+ Include test files in generation
+ junit,data,...
+ 
+
+<i>default:</i> --includeTestFiles
+===-testDataRDF RDFFILE :
+
+ Data file in RDF format
+===-jpaConfigDir JPA_CONFIG_DIR :
+
+ Directory for the persistence.xml
+===-testDataRDFS RDFSFILE :
+
+ Data file format in RDFS format
+ If absent, this RDFSFILE will be guessed from --dataRDF
+== Access control enhancement options:
+
+===-[no-]security :
+
+ Activate authentification and access control
+ 
+
+<i>default:</i> --no-security
+== BPM enhancement options:
+
+===-[no-]bpm :
+
+ Activate bpm processing
+ 
+
+<i>default:</i> --no-bpm
+===-jpdl FILE1.nt,FILE2.nt, ... :
+
+ Source jpdl xml BPM model(s)
+ 
+
+<i>default:</i> --jpdl 
+===-jpdlList FILE_list1,FILE_list2, ... :
+
+ File containing a list of jpdl file to be loaded
+===-bpm_javaSubPackage [SUBPACKAGE] :
+
+ Relative sub package where will be generated service class
+ (enums for transitions,...)
+ 
+
+<i>default:</i> --bpm_javaSubPackage bpm
+
+== Flex integration options:
+
+===-[no-]generateXMLStrutsForm :
+
+ Add XML form serializer.
+ feature introduced for FLEX
+ 
+
+<i>default:</i> --no-generateXMLStrutsForm
+===-[no-]flex :
+
+ Generate flex code
+ 
+
+<i>default:</i> --no-flex
+
+== Database persistence options:
+
+===-m, --relational_mapping objr :
+
+ Select object/relation library
+ (none,jpa,jdo,jpox,jpa)
+ 
+
+<i>default:</i> --relation_mapping none
+===-[no-]db_useStereotypeMarker :
+
+ Are persistent capable classes marked with a stereotype
+ 
+
+<i>default:</i> --no-db_useStereotypeMarker
+===-[no-]silentlyTruncateTableName :
+
+ Silently truncate generated table name to maximum sgbd allowed length.
+ 
+
+<i>default:</i> --no-silentlyTruncateTableName
+===-d, --ddl_mode [MODE] :
+
+ SGBD schema creation mode
+ (create/update/...)
+ 
+
+<i>default:</i> --ddl_mode create
+===-s, --[no-]simulateNotImplementedMethods :
+
+ Replace unimplemeted method with a simulation method.
+ 
+
+<i>default:</i> --no-simulateNotImplementedMethods
+===-[no-]java_addSuggester :
+
+ Add or remove the suggester method.
+ 
+
+<i>default:</i> --no-java_addSuggester
+===-dbTypeDiscriminator [objr] :
+
+ Column type used to store an object type in database.
+ (default,int,:default,:int)
+ 
+
+<i>default:</i> --dbTypeDiscriminator :default,:int
+===-dbDiscriminatorCacheRelFile [RBFILE] :
+
+ File where db discriminator will be saved
+ to allow subsquent generation to use the same ids
+ NOTE: generated file will not be used, unless specified using --load option
+ 
+
+<i>default:</i> --dbDiscriminatorCacheRelFile dbDiscriminatorCache.rb
+===-[no-]mysql :
+
+ Optimize for mysql.
+ 
+
+<i>default:</i> --no-mysql
+===-[no-]derby :
+
+ Optimize for derby.
+ 
+
+<i>default:</i> --no-derby
+
+== Webapp options:
+===-[no-]struts :
+
+ Enable struts generation.
+ 
+
+<i>default:</i> --no-struts
+===-[no-]java_addJavaEnumInterface :
+
+ Add Enum Interface.
+ 
+
+<i>default:</i> --no-java_addJavaEnumInterface
+===-u, --[no-]useUnzip :
+
+ Use unzip to install resources.
+ 
+
+<i>default:</i> --no-useUnzip
+===-c, --[no-]message-check :
+
+ Check message ressources consistency.
+ 
+
+<i>default:</i> --message-check
+===-webContentRelativeDir [DIRECTORY] :
+
+ Directory where webapp artefacts wil be generated (WEB-INF, META-INF, JSP, ...)
+ 
+
+<i>default:</i> --webContentRelativeDir ./WebContent/
+===-strutsActionFormPackage [SUBPACKAGE] :
+
+ SubPackage where to generate struts related classes
+ 
+
+<i>default:</i> --strutsActionFormPackage struts
+
+== EJB options:
+===-[no-]ejb2 :
+
+ Enable ejb2 experimental processing
+ 
+
+<i>default:</i> --no-ejb2
+===-t, --target_ejbconf DIRECTORY :
+
+ Destination directory for generated files
+ 
+
+<i>default:</i> --target_ejbconf 
+
+== Misc. options:
+===-[no-]generateAntBuildFile :
+
+ Generates a default ant build file
+ 
+
+<i>default:</i> --no-generateAntBuildFile
+===-versionSignature version :
+
+ Adds a version signature to generated code, so old cold will not compile.
+ (an implemented interface is added to class and interfaces)
+ 
+
+<i>default:</i> --versionSignature 
+===-[no-]skipNoReverseMarker :
+
+ Only write markers when reverse is already set to yes. Usefull to get rid of unused reverse zone and get a better code browsing experience.
+ 
+
+<i>default:</i> --no-skipNoReverseMarker
+===-[no-]silentlyForceUnknownDatatypeToString :
+
+ Silently map an unknown datatype to String. This feature should only be used for testing.
+ 
+
+<i>default:</i> --no-silentlyForceUnknownDatatypeToString
+===-[no-]java_failIfNonUniqueName :
+
+ Stop generation immediately when a name unicitiy constraint failure is detected.
+ 
+
+<i>default:</i> --java_failIfNonUniqueName
+===-[no-]groovyExperimental :
+
+ Add experimental groovy features (alpha).
+ 
+
+<i>default:</i> --no-groovyExperimental
+===-[no-]daemon :
+
+ Run this script as daemon.
+ 
+
+<i>default:</i> --no-daemon
+== Report generator:
+===-rsm6WebDocURI URL :
+
+ Base URL of RSM6 model html export
+ 
+
+<i>default:</i> -- 
+===-[no-]generateCompositionDiagram :
+
+ Generate a composition diagram (in graphviz dot file format)
+ 
+
+<i>default:</i> --no-generateCompositionDiagram
+===-[no-]checkForAbstractAndInheritance :
+
+ Check model for abstract class with inheriting classes. Stop generation if an invalid class is encountered.
+ 
+
+<i>default:</i> --no-checkForAbstractAndInheritance
+== Debug options:
+===-[no-]salvage :
+
+ Tries to handle highly defective model using best guess.
+ This feature is only intended for **quick demo** purposes.
+ Do not use for serious work!
+ 
+
+<i>default:</i> --no-salvage
+== File creation options:
+===-[no-]autoNewFileCreation :
+
+ Allows generator to create new file on its own
+ This feature should be deactivated for project under version control so no new file can be added to a project without a developper approval.
+ This feature should also be deactivated to help keep track of file rename and allow project refactoring
+ 
+
+<i>default:</i> --autoNewFileCreation
+===-[no-]allowAutomaticCodeDeletion :
+
+ Automatically ignore deleted protected code.
+ If disabled, generator will halt when reversed code is not reused in file newly created
+ 
+
+<i>default:</i> --no-allowAutomaticCodeDeletion
+===-[no-]dry-run :
+
+ Do a dry run without executing actions..
+ No file will be changed neither created on disk
+ 
+
+<i>default:</i> --no-dry-run
+===-v, --[no-]verbose :
+
+Run in verbose mode
+ 
+
+<i>default:</i> --no-verbose
+===-[no-]benchmark :
+
+ Run in benchmark mode
+ Feature usefull for optimizing generation time
+ 
+
+<i>default:</i> --no-benchmark
+===-[no-]profile :
+
+ Run in profile mode
+ Feature usefull for optimizing generation time
+ 
+
+<i>default:</i> --no-profile
+===-[no-]logFileWrite :
+
+ Log file write access to screen
+ 
+
+<i>default:</i> --no-logFileWrite
+===-[no-]selfTestAndExit :
+
+ Self test and exit.
+ (loads every dependencies)
+ (Note: used by binary generator)
+ 
+
+<i>default:</i> --no-selfTestAndExit
+===-[no-]backTrace :
+
+ Display back trace on error.
+ 
+
+<i>default:</i> --no-backTrace
+===-h, --help :
+
+ Show this message
+===-help-rdoc :
+
+ Show help in rdoc format

data/lib/ontomde-java-frontend/version.rb

@@ -0,0 +1,7 @@
+module Ontomde
+  module Java
+    module Frontend
+      VERSION = '1.0.4'
+    end
+  end
+end

data/lib/ontomde-java-frontend.rb

@@ -0,0 +1,2 @@
+
+require 'ontomde-java-frontend/version.rb'

data/test/test_ontomde-java-frontend.rb

@@ -0,0 +1,7 @@
+
+ARGV.clear
+ARGV <<  '--help'
+require 'ontomde-java-frontend/command.rb'
+
+
+

data/test/test_selfTestAndExit.rb

@@ -0,0 +1,6 @@
+
+ARGV.clear
+ARGV <<  '--selfTestAndExit'
+require 'ontomde-java-frontend/command.rb'
+
+

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification 
+name: ontomde-java-frontend
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Stephane (Pierre) Carrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-java
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-jpa
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-struts
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-kb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-kbjava
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-apaCom
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-ejb2
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-jpdl
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-flex
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: "This includes  * advanced UML2 to java generator (release) * JPA  (release) * struts (beta)  * jBPM integration * FLEX integration (beta) * junit and tests data  == SYNOPSIS:  $ ontomde-java --help  == INSTALL:"
+email: stephanepierre.carrie@orange-ftgroup.com
+executables: 
+- ontomde-java
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- lib/ontomde-java-frontend/command.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ontomde-java
+- lib/ontomde-java-frontend/command.rdoc
+- lib/ontomde-java-frontend.rb
+- lib/ontomde-java-frontend/version.rb
+- lib/ontomde-java-frontend/command.rb
+- test/test_ontomde-java-frontend.rb
+has_rdoc: true
+homepage: http://ontomde.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- lib/ontomde-java-frontend/command.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.0.0
+  version: 
+requirements: []
+
+rubyforge_project: ontomde
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: OntoMDE java generator command line utility cartridge
+test_files: 
+- test/test_ontomde-java-frontend.rb
+- test/test_selfTestAndExit.rb