Package com.inet.pdfc.results
Class ResultModel.ChangeInfo
java.lang.Object
com.inet.pdfc.results.ResultModel.ChangeInfo
- Enclosing class:
- ResultModel
Event object with a page range for both documents where the differences data has changed
-
Constructor Summary
ConstructorsConstructorDescriptionChangeInfo(ResultModel.STATE_CHANGE_TYPE type, ResultModel source, com.inet.pdfc.generator.message.PageFilterDone doneChunk, com.inet.pdfc.generator.message.ProgressState progress) Creates the event objectChangeInfo(ResultModel.STATE_CHANGE_TYPE type, ResultModel source, com.inet.pdfc.generator.message.PageReadDone doneChunk, com.inet.pdfc.generator.message.ProgressState progress) Creates the event objectChangeInfo(ResultModel.STATE_CHANGE_TYPE type, List<? extends DiffGroup> newDiffs, ResultModel source, com.inet.pdfc.generator.message.ProgressState progress) Creates the event objectChangeInfo(ResultModel source, com.inet.pdfc.generator.message.ProgressState progress) Generates an info for a change in the filterChangeInfo(ResultModel source, Map<DiffGroup, Set<Modification>> visibilityChanged) Creates an event for a change in the visibility of someModificationsChangeInfo(ResultModel source, Map<String, VisibilitySetting> settingChanges, com.inet.pdfc.generator.message.ProgressState progress) Generates an info for a change in the filter -
Method Summary
Modifier and TypeMethodDescriptionReturns the map of changes settings.intgetEndL()The end page in the first documentintgetEndR()The end page in the second documentfloatReturns the overall progress of the comparison and export in percentReturns the source data modelintThe start page in the first documentintThe start page in the second documentgetType()The type of changeReturns a map of allModifications where the visibility was changed.booleanisAffected(int pageNr, boolean first) Check whether a certain page was affected by this Change.
-
Constructor Details
-
ChangeInfo
Creates an event for a change in the visibility of someModifications- Parameters:
source- the source data model, must not benullvisibilityChanged- a map of the affectedDiffGroups andModifications. EachModificationlisted here was update in it's visibility- Since:
- 20.04
-
ChangeInfo
public ChangeInfo(ResultModel.STATE_CHANGE_TYPE type, ResultModel source, com.inet.pdfc.generator.message.PageReadDone doneChunk, com.inet.pdfc.generator.message.ProgressState progress) Creates the event object- Parameters:
type- the type of update, must not benullsource- the source data model, must not benulldoneChunk- the chunk created when a page can be comparedprogress- the overall progress of the comparison and export in percent
-
ChangeInfo
public ChangeInfo(ResultModel.STATE_CHANGE_TYPE type, ResultModel source, com.inet.pdfc.generator.message.PageFilterDone doneChunk, com.inet.pdfc.generator.message.ProgressState progress) Creates the event object- Parameters:
type- the type of update, must not benullsource- the source data model, must not benulldoneChunk- the chunk created when a page can be comparedprogress- the overall progress of the comparison and export in percent
-
ChangeInfo
public ChangeInfo(ResultModel source, Map<String, VisibilitySetting> settingChanges, com.inet.pdfc.generator.message.ProgressState progress) Generates an info for a change in the filter- Parameters:
source- the source data model, must not benullsettingChanges- the map of changed settingsprogress- the overall progress of the comparison and export in percent
-
ChangeInfo
Generates an info for a change in the filter- Parameters:
source- the source data model, must not benullprogress- the overall progress of the comparison and export in percent
-
ChangeInfo
public ChangeInfo(ResultModel.STATE_CHANGE_TYPE type, List<? extends DiffGroup> newDiffs, ResultModel source, com.inet.pdfc.generator.message.ProgressState progress) Creates the event object- Parameters:
type- the type of update, must not benullnewDiffs- the list of new differencessource- the source data model, must not benullprogress- the overall progress of the comparison and export in percent
-
-
Method Details
-
getChangedSettings
Returns the map of changes settings. The key of the map identifies the setting and the property of the setting. The value is the new value of the setting.- Returns:
- the map of changed visibilities, will be empty if the the type of this change is not
ResultModel.STATE_CHANGE_TYPE.FILTER_CHANGEbut nevernull
-
getVisibilityChanges
Returns a map of allModifications where the visibility was changed. Only relevant in case the type ifResultModel.STATE_CHANGE_TYPE.VISIBILITY_CHANGE- Returns:
- a map of all
Modifications where the visibility was changed, will benullif the type is notResultModel.STATE_CHANGE_TYPE.VISIBILITY_CHANGE
-
getStartL
public int getStartL()The start page in the first document- Returns:
- the start page in the first document
-
getStartR
public int getStartR()The start page in the second document- Returns:
- the start page in the second document
-
getEndL
public int getEndL()The end page in the first document- Returns:
- the end page in the first document
-
getEndR
public int getEndR()The end page in the second document- Returns:
- the end page in the second document
-
getType
The type of change- Returns:
- the change type
-
getSource
Returns the source data model- Returns:
- the source data model
-
isAffected
public boolean isAffected(int pageNr, boolean first) Check whether a certain page was affected by this Change.- Parameters:
pageNr- the number of the page, 0-based.first- true for the first document, false for the second.- Returns:
- true if the given page on given side was affected by this change, otherwise false.
-
getProgress
public float getProgress()Returns the overall progress of the comparison and export in percent- Returns:
- a percent value, always in interval 0 to 100
-