FirstInstance post refactoring changes #10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
from SimilarityChecker and related classes
Implement requests and handlers for certain similarity checking operations used in Java similarity switches Helps centralise the said operations Helps encapsulates some parameters that would otherwise unnecessarily clutter similarity checker and similarity switches
Builds upon the ...similarity.base package, extends and complements its elements with EMFtext Provides exemplary similarity checking requests and handlers (using them is not mandatory)
For Java-related similarity switches Currently empty Can help separate Java-related similarity switches from the rest in the future
to keep the logging logic for Java-related inner switches in one place
For Java-related inner switches to not implement some mutual operations multiple times
Created for Java-related similarity checking
For PCM-related similarity switches
For PCM-related inner similarity switches
For PCM-related similarity checker Use the extracted structure
For ID-based similarity checking of PCMs A separate similarity checker implementation will no longer be necessary To be integrated in the following future commits
For Java-related similarity checking
For logging Java-related inner switches
To their own files without modifying them Non-functional commit
Rename SimilaritySwitch to JavaSimilaritySwitch to indicate its intent better Use the extracted inner switches in the JavaSimilaritySwitch Non-functional commit
To create new Java-related similarity switches Non-functional commit
For Java-related inner switches that create further switches Non-functional commit
Use extracted structure in the Java-related inner switches Use implemented interfaces in the Java-related inner switches Non-functional commit
Non-functional commit
For Java-related similarity checking Non-functional commit
Rename SimilarityChecker to JavaSimilarityChecker Use the extracted structure in the JavaSimilarityChecker Delegate similarity switch creation by using a new similarity switch request Non-functional commit
Adapt classes affected by the changes to the Java-related part of the similarity checking Non-functional commit
To their own files without modifying them Non-functional commit
Use the extracted structure in PCM-related similarity switch Use extracted inner switches in PCM-related similarity switch Non-similarity switch
AlpTorac
force-pushed
the
fi-ref-splitted-null-check
branch
from
a56ab37 to
42c0418
Compare
Extract utility classes for similarity checking Done to help maintain consistency across similarity switches, since there are many comparisons that should be performed the same way. This also spares having to implement long/compicated if-blocks, such as null checks that care about either both elements being null or none.
Use the utility classes instead
Use ILoggableSwitch from ILoggableJavaSwitch Adapt affected classes
There are certain Commentable sub-types used by JaMoPP, which may use a Block instance, in order to store their Statement instances. If this is the case for both LocalVariableStatement (LVS) instances that are being compared, the said Block instances will be their direct container, rather than the intended one. For example: If a LVS is to be contained within a TryBlock, it is instead contained within a Block instance first, which is then contained in the TryBlock instance (TryBlock -> Block -> LVS; not TryBlock -> LVS). The changes made to the comparison of said containers makes sure that LVS comparison accounts for this effect. It is supposed to bypass the containers in-between, which are not the intended to be compared.
Retrieve their direct containers and let similarity checking decide whether they are similar. Both case methods can be asymmetric in some cases, since the container of the first element is checked before the container of the compare element (the second element).
Review required There was no case method for comparing AdditionalField instances, which are not fully initialised. This caused similarity checking to potentially return null.
Since floats and doubles can be different in some regards, their compare methods are separated. The wrapper class Float is used in compareFloat instead of Double.
Review required There was no case method for comparing PackageImport instances, which are not fully initialised. This caused similarity checking to potentially return null.
Review required There was no case method for comparing StaticClassifierImport instances, which are not fully initialised. This caused similarity checking to potentially return null.
Let normalization and string comparing logic deal with potentially null strings, since a string being null and another one being empty ("") can change the outcome of the comparison.
Use utility classes instead
Review required There was no case method for comparing EmptyModel instances. This caused similarity checking to potentially return null.
AlpTorac
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Complements the preceding pull request #9 (till acc918c), which mainly contains refactoring changes for similarity checking mechanisms, with several changes tackling various issues:
The NPEs handled here can occur when certain attributes of certain Java-Model elements (in form of EObject instances) are not set properly. To circumvent such NPEs, null checks were added to Java-related "inner switches". Concretely, at positions where certain getter/access methods could return null. These null checks respect the symmetry of the similarity checking and some of them will "fail early", if a difference is found such that the given objects cannot be similar.
Since some files were also formatted in the process, ignoring space and commentary differences makes the important changes more visible.
Known Issues