You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@opennlp.apache.org by GitBox <gi...@apache.org> on 2022/12/15 14:22:07 UTC
[GitHub] [opennlp] mawiesne opened a new pull request, #458: OPENNLP-1412 Provide equals and hashCode for ParserModel and TokenizerModel
mawiesne opened a new pull request, #458:
URL: https://github.com/apache/opennlp/pull/458
Change
-
- adds specific `equals` and `hashCode` implementations for `TokenizerModel` and `ParserModel`.
- introduces new test dependency `junit-jupiter-params` (test-scoped) to _opennlp-tools_ for more flexible test setups.
- improves `TokenizerModelTest`, `treeinsert.ParserTest` and `chunking.ParserTest` by adding further assertions and fixes TODOs.
- adds `AbstractParserModelTest` to avoid code duplication, simplifying existing test cases.
- adds another `Parse` example to demonstrate how easy it is to check different examples without duplicating code.
- removes uncommented code from both `ParserTest` variants (chunker/treeinsert) by providing actual assertions instead!
Tasks
-
Thank you for contributing to Apache OpenNLP.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [x] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
- [x] Is your initial contribution a single, squashed commit?
### For code changes:
- [x] Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
- [x] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
- [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] rzo1 commented on a diff in pull request #458: OPENNLP-1412 Provide equals and hashCode for ParserModel and TokenizerModel
Posted by GitBox <gi...@apache.org>.
rzo1 commented on code in PR #458:
URL: https://github.com/apache/opennlp/pull/458#discussion_r1049720087
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -367,4 +367,27 @@ else if (ParserType.TREEINSERT.equals(modelType)) {
throw new InvalidFormatException("Missing the head rules!");
}
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"),
+ artifactMap.get(PARSER_TAGGER_MODEL_ENTRY_NAME));
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (obj instanceof ParserModel) {
+ ParserModel model = (ParserModel) obj;
+ Map<String, Object> artifactMapToCheck = model.artifactMap;
+ AbstractModel abstractModel = (AbstractModel) artifactMapToCheck.get(BUILD_MODEL_ENTRY_NAME);
+
+ return artifactMap.get("manifest.properties").equals(artifactMapToCheck.get("manifest.properties")) &&
Review Comment:
Note for reviewers:
It looks like `artifactMap.get("manifest.properties")` is always populated as it is validated in the super class(es), so it is guaranteed to be always present in the map; the lookup result is guaranteed to be never `null` (`BaseModel#validateArtifactMap()`).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] mawiesne merged pull request #458: OPENNLP-1412 Provide equals and hashCode for ParserModel and TokenizerModel
Posted by GitBox <gi...@apache.org>.
mawiesne merged PR #458:
URL: https://github.com/apache/opennlp/pull/458
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] rzo1 commented on a diff in pull request #458: OPENNLP-1412 Provide equals and hashCode for ParserModel and TokenizerModel
Posted by GitBox <gi...@apache.org>.
rzo1 commented on code in PR #458:
URL: https://github.com/apache/opennlp/pull/458#discussion_r1049705186
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -367,4 +367,27 @@ else if (ParserType.TREEINSERT.equals(modelType)) {
throw new InvalidFormatException("Missing the head rules!");
}
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"),
+ artifactMap.get(PARSER_TAGGER_MODEL_ENTRY_NAME));
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (obj instanceof ParserModel) {
+ ParserModel model = (ParserModel) obj;
+ Map<String, Object> artifactMapToCheck = model.artifactMap;
+ AbstractModel abstractModel = (AbstractModel) artifactMapToCheck.get(BUILD_MODEL_ENTRY_NAME);
+
+ return artifactMap.get("manifest.properties").equals(artifactMapToCheck.get("manifest.properties")) &&
Review Comment:
see above
##########
opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java:
##########
@@ -162,4 +163,26 @@ public Dictionary getAbbreviations() {
public boolean useAlphaNumericOptimization() {
return getFactory() != null && getFactory().isUseAlphaNumericOptmization();
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"), artifactMap.get(TOKENIZER_MODEL_ENTRY));
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (obj instanceof TokenizerModel) {
+ TokenizerModel model = (TokenizerModel) obj;
+ Map<String, Object> artifactMapToCheck = model.artifactMap;
+ AbstractModel abstractModel = (AbstractModel) artifactMapToCheck.get(TOKENIZER_MODEL_ENTRY);
+
+ return artifactMap.get("manifest.properties").equals(artifactMapToCheck.get("manifest.properties")) &&
Review Comment:
see above
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -367,4 +367,27 @@ else if (ParserType.TREEINSERT.equals(modelType)) {
throw new InvalidFormatException("Missing the head rules!");
}
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"),
Review Comment:
Can we use ` MANIFEST_ENTRY` from `BaseModel` ?
##########
opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerModel.java:
##########
@@ -162,4 +163,26 @@ public Dictionary getAbbreviations() {
public boolean useAlphaNumericOptimization() {
return getFactory() != null && getFactory().isUseAlphaNumericOptmization();
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"), artifactMap.get(TOKENIZER_MODEL_ENTRY));
Review Comment:
see above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [opennlp] rzo1 commented on a diff in pull request #458: OPENNLP-1412 Provide equals and hashCode for ParserModel and TokenizerModel
Posted by GitBox <gi...@apache.org>.
rzo1 commented on code in PR #458:
URL: https://github.com/apache/opennlp/pull/458#discussion_r1049720087
##########
opennlp-tools/src/main/java/opennlp/tools/parser/ParserModel.java:
##########
@@ -367,4 +367,27 @@ else if (ParserType.TREEINSERT.equals(modelType)) {
throw new InvalidFormatException("Missing the head rules!");
}
}
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(artifactMap.get("manifest.properties"),
+ artifactMap.get(PARSER_TAGGER_MODEL_ENTRY_NAME));
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (obj instanceof ParserModel) {
+ ParserModel model = (ParserModel) obj;
+ Map<String, Object> artifactMapToCheck = model.artifactMap;
+ AbstractModel abstractModel = (AbstractModel) artifactMapToCheck.get(BUILD_MODEL_ENTRY_NAME);
+
+ return artifactMap.get("manifest.properties").equals(artifactMapToCheck.get("manifest.properties")) &&
Review Comment:
Note for reviewers:
It looks like `artifactMap.get("manifest.properties")` is always populated as it is validated in the super class(es), so it is guaranteed to be always present in the map; so it is guaranteed to be never `null` (`BaseModel#validateArtifactMap()`).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org