Skip to Content

Wiki source code of WOProject-FrameworkSet

Last modified by Gavin Eadie on 2011/04/26 22:46
Show last authors
1 = FrameworkSet Structure =
2
3 This has been transcribed by [[Andrew Lindesay>>url:http://www.lindesay.co.nz||shape="rect"]] from the old WOProject site.
4
5 == Description ==
6
7 {{code language="none"}}FrameworkSet{{/code}} is an extension of [[Ant FileSet>>url:http://ant.apache.org/manual/CoreTypes/fileset.html||shape="rect"]] that allows matching and conditional inclusion of frameworks. It is used as a nested element by various WOProject tasks. When building a FrameworkSet, path should match up to the "*.framework" directory (no need to match individual JAR files).
8
9 == Parameters ==
10
11 |=(((
12 Attribute
13 )))|=(((
14 Description
15 )))|=(((
16 Required
17 )))
18 |(((
19 dir
20 )))|(((
21 A base directory for the include/exclude pattern lookup. When the prefix for the directory matches one of {{code language="none"}}wo.root{{/code}}, {{code language="none"}}wo.localroot{{/code}} etc. this prefix will get replaced in the final class file by {{code language="none"}}WOROOT{{/code}}, {{code language="none"}}LOCALROOT{{/code}} etc. and these paths in turn will get translated by the environment variables in the startup script to the final path.
22 )))|(((
23 Yes
24 )))
25 |(((
26 deploymentDir
27 )))|(((
28 The base directory that is prefixed to the frameworks in the classpath files. This allows you to decouple your compile time paths from the deployment paths. Useful when you have vastly different file layouts in the development vs. the deployment server. Used only when inside a {{code language="none"}}woapplication{{/code}} task.
29 )))|(((
30 No
31 )))
32 |(((
33 if
34 )))|(((
35 The name of a property that determines if the framework set is included. If present, this property is used for conditional inclusion of the matched framework. Property name should not be included in {{code language="none"}}${{/code}}, as a property name, not value, is expected.
36 )))|(((
37 No
38 )))
39 |(((
40 embed
41 )))|(((
42 Indicates if these frameworks should be embedded (e.g. within an application bundle).
43 )))|(((
44 No
45 )))
46 |(((
47 bundles
48 )))|(((
49 A '/' separated list of bundles to take from <dir>. This is an alternative to using the embedded <include> tag. This way, it's much easier to simply put all the relevant stuff inside the build.properties and forget about all the patternset files.
50 )))|(((
51 No
52 )))
53 |(((
54 root
55 )))|(((
56 **DEPRECATED** use dir instead.
57 )))|(((
58 -
59 )))
60
61 **Note: all standard FileSet parameters are supported as well.**
62
63 == Examples ==
64
65 Using nested "frameworks" element that is a FrameworkSet inside WOCompile task:
66
67 {{code 0="xml"}}
68
69 <wocompile srcdir="Java" destdir="classes">
70
71 <frameworks dir="../Frameworks">
72 <include name="JavaWOExtension.framework"/>
73 <include name="ER*.framework"/>
74 <exclude name="ERNeutralLook.framework"/>
75 </frameworks>
76
77 <frameworks dir="${wo.localroot}">
78 <include name="Mysql*.framework"/>
79 </frameworks>
80
81 </wocompile>
82
83 {{/code}}
84
85 Using **bundles** instead of **include**:
86
87 {{code 0="xml"}}
88
89 <wocompile srcdir="Java" destdir="classes">
90 <frameworks dir="${wo.wolocalroot}/Library/Frameworks"
91 embed="true"
92 bundles="ERJars/ERExtensions/PostgresqlPlugIn/Ajax/ERDirectToWeb/ERJavaMail/ERWebServices/JavaWOExtensions/LUNeutralLook">
93 </frameworks>
94 </wocompile>
95
96 {{/code}}