org.daisy.dotify.api.formatter

Class RenameFallbackRule

java.lang.Object

org.daisy.dotify.api.formatter.RenameFallbackRule

All Implemented Interfaces:

FallbackRule

public class RenameFallbackRule
extends java.lang.Object
implements FallbackRule

Provides a fallback rule that indicates that the collection should be reassigned to another identifier.

Constructor Summary

Constructors

Constructor and Description
RenameFallbackRule(java.lang.String fromCollection, java.lang.String toCollection) Creates a new instance with the specified parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyToCollection() Gets the identifier of the collection that this rule should be applied to.
java.lang.String	getToCollection() Gets the new identifier for this collection
boolean	mustBeContextCollection() Returns true of the rule can only be applied to the context collection, in other words the collection that triggers the fallback actions.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameFallbackRule

public RenameFallbackRule(java.lang.String fromCollection,
                          java.lang.String toCollection)

Creates a new instance with the specified parameters

Parameters:

fromCollection - the identifier of the original collection

toCollection - the new identifier

Method Detail

applyToCollection

public java.lang.String applyToCollection()

Description copied from interface: FallbackRule

Gets the identifier of the collection that this rule should be applied to.

Specified by:

applyToCollection in interface FallbackRule

Returns:

returns the identifier

getToCollection

public java.lang.String getToCollection()

Gets the new identifier for this collection

Returns:

returns the identifier

mustBeContextCollection

public boolean mustBeContextCollection()

Description copied from interface: FallbackRule

Returns true of the rule can only be applied to the context collection, in other words the collection that triggers the fallback actions.

Specified by:

mustBeContextCollection in interface FallbackRule

Returns:

returns true if the rule can only be applied to the context collection, false otherwise