Package com.logicaldoc.comparison
Class AbstractDocumentComparator
java.lang.Object
com.logicaldoc.comparison.AbstractDocumentComparator
- All Implemented Interfaces:
DocumentComparator
- Direct Known Subclasses:
BasicComparator
,NotAvailableComparator
,WorkShareComparator
Abstract comparator.
- Since:
- 8.2.3
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
compare
(String sid, com.logicaldoc.core.document.Version originalVersion, com.logicaldoc.core.document.Version modifiedVersion, File dest) Performs the comparisonfinal void
Performs the comparisonboolean
getParameter
(String name) Gets the value of a parameterImplementations should return the list of the required parameters.Returns the map of parametersint
hashCode()
boolean
Checks if the comparator is enabled or notvoid
Reads it's own parameters and stores them in the parameters mapvoid
setEnabled
(boolean enabled) Enables or disables the comparator
-
Method Details
-
compare
public final void compare(String sid, File original, File modified, File target) throws IOException, com.logicaldoc.core.parser.ParsingException 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 comparisoncom.logicaldoc.core.parser.ParsingException
- error in the parsing
-
compare
public final void compare(String sid, com.logicaldoc.core.document.Version originalVersion, com.logicaldoc.core.document.Version modifiedVersion, File dest) throws IOException, com.logicaldoc.core.PersistenceException, com.logicaldoc.core.parser.ParsingException 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 comparisoncom.logicaldoc.core.PersistenceException
- error at database levelcom.logicaldoc.core.parser.ParsingException
- error in the parsing
-
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
Description copied from interface:DocumentComparator
Returns the map of parameters- Specified by:
getParameters
in interfaceDocumentComparator
- Returns:
- map of parameters
-
getParameter
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
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
-
hashCode
public int hashCode() -
equals
-