Package com.logicaldoc.comparison
Class AbstractDocumentComparator
- java.lang.Object
-
- com.logicaldoc.comparison.AbstractDocumentComparator
-
- All Implemented Interfaces:
DocumentComparator
- Direct Known Subclasses:
BasicComparator
,NotAvailableComparator
,WorkShareComparator
public abstract class AbstractDocumentComparator extends Object implements DocumentComparator
Abstract comparator.- Since:
- 8.2.3
- Author:
- Marco Meschieri - LogicalDOC
-
-
Constructor Summary
Constructors Constructor Description AbstractDocumentComparator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
compare(String sid, com.logicaldoc.core.document.Version originalVersion, com.logicaldoc.core.document.Version modifiedVersion, File dest)
Performs the comparisonvoid
compare(String sid, File original, File modified, File target)
Performs the comparisonboolean
equals(Object other)
String
getParameter(String name)
Gets the value of a parameterList<String>
getParameterNames()
Implementations should return the list of the required parameters.Map<String,String>
getParameters()
Returns the map of parametersint
hashCode()
boolean
isEnabled()
Checks if the comparator is enabled or notvoid
loadParameters()
Reads it's own parameters and stores them in the parameters mapvoid
setEnabled(boolean enabled)
Enables or disables the comparator
-
-
-
Method Detail
-
compare
public final void compare(String sid, File original, File modified, File target) throws IOException
Description copied from interface:DocumentComparator
Performs the comparison- Specified by:
compare
in interfaceDocumentComparator
- Parameters:
sid
- identifier of the sessionoriginal
- The original filemodified
- The modified filetarget
- The comparison output as PDF file- Throws:
IOException
- error writing the temporary files or in the comparation
-
compare
public final void compare(String sid, com.logicaldoc.core.document.Version originalVersion, com.logicaldoc.core.document.Version modifiedVersion, File dest) throws IOException
Description copied from interface:DocumentComparator
Performs the comparison- Specified by:
compare
in interfaceDocumentComparator
- Parameters:
sid
- The actual Session IDoriginalVersion
- The original versionmodifiedVersion
- The modified versiondest
- The comparison output as PDF file- Throws:
IOException
- error writing the temporary files or in the comparation
-
loadParameters
public void loadParameters()
Description copied from interface:DocumentComparator
Reads it's own parameters and stores them in the parameters map- Specified by:
loadParameters
in interfaceDocumentComparator
-
isEnabled
public boolean isEnabled()
Description copied from interface:DocumentComparator
Checks if the comparator is enabled or not- Specified by:
isEnabled
in interfaceDocumentComparator
- Returns:
- the enabled status
-
setEnabled
public void setEnabled(boolean enabled)
Description copied from interface:DocumentComparator
Enables or disables the comparator- Specified by:
setEnabled
in interfaceDocumentComparator
- Parameters:
enabled
- the new enabled status
-
getParameters
public Map<String,String> getParameters()
Description copied from interface:DocumentComparator
Returns the map of parameters- Specified by:
getParameters
in interfaceDocumentComparator
- Returns:
- map of parameters
-
getParameter
public String getParameter(String name)
Description copied from interface:DocumentComparator
Gets the value of a parameter- Specified by:
getParameter
in interfaceDocumentComparator
- Parameters:
name
- name of the parameter- Returns:
- value of the configuration parameter
-
getParameterNames
public List<String> getParameterNames()
Description copied from interface:DocumentComparator
Implementations should return the list of the required parameters. A parameter is stored in the context as comparator.SimpleClassName.parameter = value- Specified by:
getParameterNames
in interfaceDocumentComparator
- Returns:
- the list of configuration parameters
-
-