Create method to add SearchHit info to metadata

[Mikwiss]

Hi all !

We use ElasticSearch/AbstractSpout and we want to add some SearchHit info to metadata (es document id in our case).

Actually, we already do it with a ForkCollapsingSpout, but we rather not to fork a class only for that.

public class CustomCollapsingSpout extends ForkCollapsingSpout {
  @Override
  protected void addHitInfoToMetadata(Map<String, List<String>> metadata, SearchHit hit) {
      metadata.put("es.uuid", hit.getId());
  }
}

We can also remove final to addHitToBuffer(SearchHit hit) instead of this new method, it's up to you ! 👍

Thanks for all reviewers !

Signed-off-by: Mathieu Bret mikwiss00@gmail.com

Thanks for contributing to StormCrawler, your efforts are appreciated!

Developer Certificate of Origin

By contributing to StormCrawler, you accept and agree to the following terms and conditions (the Developer Certificate of Origin) for your present and future contributions submitted to StormCrawler.
Please refer to the Developer Certificate of Origin section in CONTRIBUTING.md for details.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Before opening a PR, please check that:

• You've squashed your commits into a single one
• You've described what the PR does or at least point to a related issue
• You've signed-ff your commits with 'git commit -s'
• The code is properly formatted with 'mvn git-code-format:format-code -Dgcf.globPattern=**/*'

Thanks!

[jnioche]

I am not against the idea but the implementation is not quite right, see comments
Thanks @Mikwiss

[jnioche]

what happens to the metadatas object afterwards? it would feel more logical if it did something to the actual metadata object which is being returned.

[jnioche]

Move that right after the line 166

String url = (String) keyValues.get("url");

[jnioche]

I would store the value returned by fromKeyValues(keyValues) in a variable
and have addHitInfoToMetadata() operate on it and become

addHitInfoToMetadata(Metadata metadata, SearchHit hit)

[Mikwiss]

Thanks @jnioche ! You're right, it was a bit childish 👎

[jnioche]

Thanks @Mikwiss