Feature/code clean up

[dav009]

So this is a big code clean up of the model editor:

• Styled the code a bit using:
  • scalariform and scalastyle
  • as well as following: http://docs.scala-lang.org/style/
  • There are few warnings still thrown by scalastyle (i.e: using return statements) I think we can remove them as we go on refactoring other bits

----UPDATE----

The other relevant changes are:

• Stores are now loaded in a lazy way. This should improve speed when only working with a particular store
• Only stores which are used are exported. This should also improve speed
• Renamed the store classes
• Replaced some of the for loops with foreach loops
• Using scopt library to create command-line parser
• Command-line interface has changed( check readme for details)
  • command : surfaceform, with the following actions:
  • make-spottable
  • make-no-spottable
  • candidates
  • stats
    • copy-candidates
  • command: topic, with the following actions:
  • search
  • check-context
  • clean-set-context
  • command: association with the follownig actions:
  • remove
  • command: file-update with the following actions:
  • all
  • only-context
• Refactor the code parsing the input files
• Put all the stores in a separate package

--- Update 2 ---

• Added a maven plugin which generates a script calling the jar. So we avoid writting the same over an over. the script is generated in target/bin/model-editor. So now running hte model editor is just: target/bin/model-editor surfaceform make-spottable pathToModel/model Barack

I would like to remove the Updating a model From File (Two Steps) part in the docs. Since anyway this is meant to run in a big machine, any arguments against it?

---

• [x] far
• [x] Thiango

[tgalery]

I mentioned to you in passing that it would be nice to have a too similar to knife. Like the first argument of the editor would an entity (surface form, candidate, or resource) and the next argument would be an action (make-spotable, associate, change context), but i think this would take a while to fix, so maybe in another life we could do this.

[dav009]

It doesn't sound so complicated. I will take a look for a lib similar to python's optpars

[tgalery]

Cool, but it's still a minor point, so up to you whether you fancy doing that.

[dav009]

@tgalery you can rereview!

[dav009]

• Fixed line lengths
• Added Headers with candidate license
• Added Notice/License Files
• Specified licenses of dependencies in POM file

@tgalery ready for re-re-re-re-re-re-re....-re review

[tgalery]

Looks good :+1: :sake: . The only tiny thing, should we have a license.txt file linked from within the readme. Also, a few suggestions for actions change.

make-spottable => make-spotable (I think spotable is with only one 't' but i m not sure) make-no-spottable => make-unspotable only-context => context-only

Is that ok ?

[dav009]

sure. spottable seems to be alright

There is a link in readme.md to the standard apache 2.0 license, which is what I usually saw in the readme's of the big companies.

[papaonlegs]

Looks like it's ready to be merged.

[dav009]

YAY!!!!