To edit or add content to this Wiki, you can simply create a new account at http://wocommunity.org/account.

Skip to end of metadata
Go to start of metadata

FrameworkSet Structure

This has been transcribed by Andrew Lindesay from the old WOProject site.

Description

FrameworkSet is an extension of Ant FileSet 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).

Parameters

Attribute

Description

Required

dir

A base directory for the include/exclude pattern lookup. When the prefix for the directory matches one of wo.root, wo.localroot etc. this prefix will get replaced in the final class file by WOROOT, LOCALROOT etc. and these paths in turn will get translated by the environment variables in the startup script to the final path.

Yes

deploymentDir

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 woapplication task.

No

if

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 $, as a property name, not value, is expected.

No

embed

Indicates if these frameworks should be embedded (e.g. within an application bundle).

No

bundles

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.

No

root

DEPRECATED use dir instead.

-

Note: all standard FileSet parameters are supported as well.

Examples

Using nested "frameworks" element that is a FrameworkSet inside WOCompile task:

<wocompile srcdir="Java" destdir="classes">

   <frameworks dir="../Frameworks">
      <include name="JavaWOExtension.framework"/>
      <include name="ER*.framework"/>
      <exclude name="ERNeutralLook.framework"/>
   </frameworks>

   <frameworks dir="${wo.localroot}">
      <include name="Mysql*.framework"/>
   </frameworks>

 </wocompile>

Using bundles instead of include:

<wocompile srcdir="Java" destdir="classes">
    <frameworks dir="${wo.wolocalroot}/Library/Frameworks"
                embed="true"
                bundles="ERJars/ERExtensions/PostgresqlPlugIn/Ajax/ERDirectToWeb/ERJavaMail/ERWebServices/JavaWOExtensions/LUNeutralLook">
    </frameworks>
 </wocompile>
  • No labels

2 Comments

  1. There's also an "eclipse=..." parameter.  What does that do?

    1. Eclipse="true" causes the frameworkset to refer to the Eclipse file '.classpath' to embed frameworks listed therein.