info.magnolia.module.delta
Class FilterOrderingTask

java.lang.Object
  info.magnolia.module.delta.AbstractTask
      info.magnolia.module.delta.AbstractRepositoryTask
          info.magnolia.module.delta.FilterOrderingTask

All Implemented Interfaces:

Task

public class FilterOrderingTask
extends AbstractRepositoryTask

Orders a filter after a given set of other filters. The filter is placed directly after the last of other filters. The other filters can be required or optional, if a required filter isn't present this task will do nothing and report a warning. If all other filters are optional and none are present this task does nothing. Does not take nested filters into account.

Version:

$Id$

See Also:

OrderFilterBeforeTask

Field Summary

Fields inherited from class info.magnolia.module.delta.AbstractTask

log

Constructor Summary

FilterOrderingTask(String filterName, String[] requiredFiltersBefore)

FilterOrderingTask(String filterName, String[] requiredFiltersBefore, String[] optionalFiltersBefore)

FilterOrderingTask(String filterName, String description, String[] requiredFiltersBefore)

FilterOrderingTask(String filterName, String description, String[] requiredFiltersBefore, String[] optionalFiltersBefore)

Method Summary

protected void

doExecute(InstallContext ctx)

Methods inherited from class info.magnolia.module.delta.AbstractRepositoryTask

execute

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterOrderingTask

public FilterOrderingTask(String filterName,
                          String[] requiredFiltersBefore)

Parameters:

filterName - name of filter to be placed after the required filters.

requiredFiltersBefore - an array of filter names that must appear before the filter specified as filterName.

FilterOrderingTask

public FilterOrderingTask(String filterName,
                          String[] requiredFiltersBefore,
                          String[] optionalFiltersBefore)

FilterOrderingTask

public FilterOrderingTask(String filterName,
                          String description,
                          String[] requiredFiltersBefore)

FilterOrderingTask

public FilterOrderingTask(String filterName,
                          String description,
                          String[] requiredFiltersBefore,
                          String[] optionalFiltersBefore)

Method Detail

doExecute

protected void doExecute(InstallContext ctx)
                  throws javax.jcr.RepositoryException,
                         TaskExecutionException

Specified by:

doExecute in class AbstractRepositoryTask

Throws:

javax.jcr.RepositoryException

TaskExecutionException