com.deltaxml.ditamerge

Class RuleConfiguration

java.lang.Object

com.deltaxml.ditamerge.RuleConfiguration

public class RuleConfiguration
extends Object

Allows the rule based processing to be configured for the Dita Concurrent Merge or Three Way Dita Merge object. Supplies configuration info which is used during extract operations. The configuration applies rules to process both deltaV2 and simplified-delta outputs. Could be extended in future.

See Also:

ConcurrentMerge.setRuleConfiguration(com.deltaxml.ditamerge.RuleConfiguration), ConcurrentMerge.getRuleConfiguration()

Constructor Summary

Constructors

Constructor and Description
RuleConfiguration() Create a new RuleConfiguration about that contains settings for DitaMerge rule based processing.

Method Summary

Modifier and Type	Method and Description
Set<String>	getDisplayChangesInvolving() Reports the current setting of the display Changes by parameter.
String	getDisplayChangesTo() Reports the current setting of DisplayChangesTo.
String	getDisplayFormatChangesIn() Reports the current setting of DisplayFormatChangesIn.
boolean	getDisplaySimpleAdds() Reports the current setting of the displaySimpleAdds parameter.
boolean	getDisplaySimpleDeletes() Reports the current setting of the displaySimpleDeletes parameter.
boolean	getDisplaySimpleModify() Reports the current setting of the displaySimpleModify parameter.
List<String>	getVersionPriorityList() Reports the current setting of the version priority list.
void	setDisplayChangesInvolving(Set<String> versions) Specifies the set of versions for which all changes should be displayed.
void	setDisplayChangesTo(String xpath) Specifies which elements in the result are always displayed to the user.
void	setDisplayFormatChangesIn(String xpath) Specifies which elements contain formatting elements, where the user wants formatting changes displayed.
void	setDisplaySimpleAdds(boolean display) Controls whether simple adds are displayed.
void	setDisplaySimpleDeletes(boolean display) Controls whether simple deletes are displayed.
void	setDisplaySimpleModify(boolean display) Controls whether simple modifications are displayed.
void	setVersionPriorityList(List<String> priorityList) Specifies the priority version list for resolving simple conflicts.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleConfiguration

public RuleConfiguration()

Create a new RuleConfiguration about that contains settings for DitaMerge rule based processing.

Method Detail

setDisplayChangesInvolving

public void setDisplayChangesInvolving(Set<String> versions)

Specifies the set of versions for which all changes should be displayed.

Parameters:

versions - a set of delta versions specified using Strings

getDisplayChangesInvolving

public Set<String> getDisplayChangesInvolving()

Reports the current setting of the display Changes by parameter.

Returns:

the current set of versions which are displayed

setDisplayChangesTo

public void setDisplayChangesTo(String xpath)
                         throws IllegalArgumentException

Specifies which elements in the result are always displayed to the user. That is, elements that will never have their differences resolved by rule-based processing.

Parameters:

xpath - An XPath expression (up to XPath 3.1) that returns 0 or more elements when evaluated against the raw result.

Throws:

IllegalArgumentException - if the string is null, zero length or cannot be compiled to an XPath

getDisplayChangesTo

public String getDisplayChangesTo()

Reports the current setting of DisplayChangesTo.

Returns:

a String representing the XPath

setDisplayFormatChangesIn

public void setDisplayFormatChangesIn(String xpath)
                               throws IllegalArgumentException

Specifies which elements contain formatting elements, where the user wants formatting changes displayed.

Parameters:

xpath - An XPath expression (up to XPath 3.1) that returns 0 or more elements when evaluated against the raw result.

Throws:

IllegalArgumentException - if the string is null, zero length or cannot be compiled to an XPath

getDisplayFormatChangesIn

public String getDisplayFormatChangesIn()

Reports the current setting of DisplayFormatChangesIn.

Returns:

a String representing the XPath

setDisplaySimpleAdds

public void setDisplaySimpleAdds(boolean display)

Controls whether simple adds are displayed.

Parameters:

display - when true all adds are displayed, when false adds are displayed according to other rules

getDisplaySimpleAdds

public boolean getDisplaySimpleAdds()

Reports the current setting of the displaySimpleAdds parameter.

Returns:

a boolean indicating whether simple adds are always displayed

setDisplaySimpleDeletes

public void setDisplaySimpleDeletes(boolean display)

Controls whether simple deletes are displayed.

Parameters:

display - when true all deletes are displayed, when false deletes are displayed according to other rules

getDisplaySimpleDeletes

public boolean getDisplaySimpleDeletes()

Reports the current setting of the displaySimpleDeletes parameter.

Returns:

a boolean indicating whether simple deletes are always displayed

setDisplaySimpleModify

public void setDisplaySimpleModify(boolean display)

Controls whether simple modifications are displayed.

Parameters:

display - when true all modifications are displayed, when false modifications are displayed according to other rules

getDisplaySimpleModify

public boolean getDisplaySimpleModify()

Reports the current setting of the displaySimpleModify parameter.

Returns:

a boolean indicating whether simple modifications are always displayed

setVersionPriorityList

public void setVersionPriorityList(List<String> priorityList)

Specifies the priority version list for resolving simple conflicts.

Parameters:

priorityList - a list of priority versions specified using Strings

getVersionPriorityList

public List<String> getVersionPriorityList()

Reports the current setting of the version priority list.

Returns:

the current list of priority versions