net.dpml.metro.tools
Class CatalogTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.dpml.metro.tools.CatalogTask

public class CatalogTask

extends Task

Create a set of html reports about component types.

Version:

1.0.0

Author:

Digital Product Meta Library

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

CatalogTask()

Method Summary

void	addFileset(FileSet set) Add a fileset to the set of filesets definted within the catalog generation.
void	execute() Task execution during which all component types declared in the current project or referenced by nested filesets will be used as the source defintions fro the generation of a Type catalog.
void	init() Task initialization.
void	setDest(File destination) Set the final destination directory for generated HTML content.
void	setStyle(String style) Optional override of the XSL stylesheet used to transform type descriptors.
void	setTitle(String title) Optional override of the index page title.

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatalogTask

public CatalogTask()

Method Detail

setDest

public void setDest(File destination)

Set the final destination directory for generated HTML content.

Parameters:

destination - the destination directory

setStyle

public void setStyle(String style)

Optional override of the XSL stylesheet used to transform type descriptors.

Parameters:

style - the XSL transformation to use

setTitle

public void setTitle(String title)

Optional override of the index page title.

Parameters:

title - the index page title

addFileset

public void addFileset(FileSet set)

Add a fileset to the set of filesets definted within the catalog generation. If no filesets are added the default behaviour will be resolve against component types declared under the current projects ${basedir}/target/classes directory.

Parameters:

set - the fileset to add

init

public void init()

Task initialization.

execute

public void execute()

Task execution during which all component types declared in the current project or referenced by nested filesets will be used as the source defintions fro the generation of a Type catalog.