Added model.entry.FieldName that contains field name constants by oscargus · Pull Request #1602 · JabRef/jabref

oscargus · 2016-07-18T22:25:25Z

Based on the idea that all fields should have a constant, I started to implement this. The ideas are (please comment):

Class position and name: model.entry.FieldName
Constant naming scheme AUTHOR_FIELD
Only use the constants when denoting the actual fields of an entry. Strings with the same content, but different purpose are not replaced (sometimes it is not obvious though).
The constants are not used in test.

I do not expect to convert all fields in this PR, but I wanted some comments on it before continuing further.

tobiasdiez · 2016-07-19T09:06:28Z

Nice idea. I would even go one step further and

Make FieldName an enum. This would probably require to introduce overloads accepting the enum, e. g. getFieldOptional(FieldName field) { return getFieldOptional(field.name()) }. With the aim to replace strings completely using the extended enum pattern
Introduce helper methods in BibEntry which return values for common fields, e.g. getAuthors() { return getFieldOptional(FieldName.Authors); }

matthiasgeiger · 2016-07-19T09:19:46Z

👍
Some remarks:

Instead of using FieldName.AUTHOR_FIELD I would propose to omit the _FIELD suffix. FieldName.AUTHOR is less clumsy and would result in easier to read lists of field as they are used in the entry type definitions...
What will happen to those "OR" fields such as "year/date" - directly use this as a constant? Or use a method orField(FieldName.YEAR, FieldName.DATE)?

Regarding the enum usage: Basically this would be the better approach - but as the the user can define his own "custom fields" things get rather complicated as there always must be two ways to deal with field definitions

simonharrer · 2016-07-19T09:32:13Z

👍 but I would just use string constants for now, being in line with the argument from @matthiasgeiger .

tobiasdiez · 2016-07-19T09:34:00Z

@matthiasgeiger One can use the extended enum pattern for user-defined fields. It would roughly look like:

interface FieldName { 
  String getName(), 
  List<FieldName> getAliases(),
  FieldName convertToBibLatex(),
  FieldName convertToLatex(),
  ...
}

enum StandardFieldName implements FieldName { 
  Authors("authors", ...), 
  Title("title", ...), ... 
}

class UnknownFieldName implements FieldName {
  UnknownFieldName(String name) {...}

  @Override getName() {return name; }
  @Override ...
}

Siedlerchr · 2016-07-19T09:39:08Z

That Extended Enum looks interesting.

2016-07-19 11:34 GMT+02:00 Tobias Diez notifications@github.com:

@matthiasgeiger https://github.com/matthiasgeiger One can use the extended
enum pattern https://blogs.oracle.com/darcy/entry/enums_and_mixins for
user-defined fields. It would roughly look like:

interface FieldName {
String getName(),
List getAliases(),
convertToBibLatex(),
convertToLatex(),
...
}
enum StandardFieldName implements FieldName {
Authors("authors", ...),
Title("title", ...), ...
}
class UnknownFieldName implements FieldName {
UnknownFieldName(String name) {...}

@OverRide getName() {return name; }
@OverRide ...
}

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#1602 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AATi5JbGFc85zPL5Hy9RjS6OqV-4uWQuks5qXJoJgaJpZM4JPM_L
.

simonharrer · 2016-07-19T12:13:29Z

Hm, this could work, but on the other hand, it introduces additional complexity into the model, and everybody working with the model then must learn this pattern. I would like to keep the model simple, and would at first use only such String constants.

oscargus · 2016-07-20T08:24:54Z

I've removed the _FIELD part for now.

Considering enum one should maybe think about InternalBibtexFields as well, creating a class/enum that can contain all information about a field (maybe including column widths etc).

Combined fields, I was thinking of just doing a string concatenation (as they are just constants in a few places), but it may make sense to create a function for this.

oscargus · 2016-07-20T08:31:51Z

There are two types of combined fields: one with / as separator for columns and one with ; as separator for preferences. FieldNames.orFields(List<String) and FieldNames.andFields(List<String)?

oscargus · 2016-07-20T21:00:29Z

I think I'm happy for now. A bit tedious and there are quite a few fields to convert... Most of the most common ones should be converted already though. May be better to merge now as it is quite boring rebasing with conflicts...

@tobiasdiez : I think adding get-methods clearly makes sense, although I also think that getAuthors() should return Optional<AuthorList>. :-)

simonharrer · 2016-07-21T12:22:24Z

I think this is a huge step forward, and would merge this ASAP.

matthiasgeiger · 2016-07-21T12:27:19Z

👍 Just merge after rebasing!

oscargus · 2016-07-21T13:01:01Z

I merge this now. The failing test seems to relate to a lack of internet connection rather than anything else. Also, I do not understand how to get things up and running with the new medline fetcher, but that shouldn't affect this PR...

* master: (268 commits) Added DateFormatter to LayoutEntry so that it actually works... (JabRef#1619) Implemented JabRef#1345 - cleanup ISSN (JabRef#1590) Always use https for help files (JabRef#1615) Resolves JabRef#1613 Use Jabref default icon for uninstaller for now (JabRef#1616) Added more fields and fixed some issues (JabRef#1617) Added LayoutFormatterPreferences (and related files) (JabRef#1608) [WIP] Create new fetcher infrastructure (JabRef#1594) Set user agent to fix 403 status error More fields added to FieldName (JabRef#1614) Added model.entry.FieldName that contains field name constants (JabRef#1602) Fixes imports Test CustomImporter (JabRef#1501) The field list gets the focus as soon as it is focused (JabRef#1541) When clicking on a tab, the first field now has the focus (JabRef#988) Add test in BibEntryWriterTest for type change Rewrite MedlineImporter with JAXB and add nbib fields (JabRef#1479) Some Globals.prefs injection in logic and model (JabRef#1593) Added filter to not show selected integrity checks (JabRef#1588) Replace getField with getFieldOptional in all of the tests and in som… (JabRef#1591) Move preferences (JabRef#1604) ... # Conflicts: # src/main/java/net/sf/jabref/importer/ImportMenuItem.java # src/main/java/net/sf/jabref/importer/OpenDatabaseAction.java

@comment

Move event (JabRef#1601) * Move event package to model Update dependencies: postgres 9.4.1208 -> 9.4.1209 and wiremock from 2.1.6 to 2.1.7 Added ISBN integrity checker (JabRef#1586) Added ISBN integrity checker * Extracted ISBN class Reenable errorprone (see http://errorprone.info/) Extend the OpenConsoleFeature (JabRef#1582) * Extend the OpenConsoleFeature by selection of custom terminal emulator. - Add radio selection to the AdvancedTab - Add new JabRefPreferences - Add file check and execution commands - Add localization keys * Fix localization key. * Move console selection to ExternalTab.java * Change localization entry. * Add command executor. * Fix placeholder replacement. * Fix codacy. * Update localization key. * Remove "Specify terminal emulator" option. Add GUI outputs. * Set default command for Windows. Fix localization entries. * Remove empty lines in language files. * Use lambda expressions insead of ActionListeners * Refactoring. * Update CHANGELOG.md. * Small refactorings. Move preferences (JabRef#1604) * Move preferences-related classes into separate package * Rename JabRefPreferencesFilterDialog -> PreferencesFilterDialog and move it to gui * Fix checkstyle warning Set user agent to fix 403 status error Replace getField with getFieldOptional in all of the tests and in som… (JabRef#1591) * Replace getField with getFieldOptional in all of the tests and in some more code * Some more conversions Added filter to not show selected integrity checks (JabRef#1588) * Added filter to not show selected integrity checks * Removed unused variable Some Globals.prefs injection in logic and model (JabRef#1593) * Some Globals.prefs injection in logic and model * Some more conversions and some fixes * More injections * Even more injections * Yes, even more injections * Indeed, even more injections * Probably the last injections for now * Removed unrequired dependency and fixed issue * Dropped support for selecting sub/super to equations * Added preference classes for LatexFieldFormatter and FieldContentParser * Removed some left over code * Added JournalAbbreviationPreferences * Encapsulated LatexFieldFormatterPreferences in SavePreferences * Changed getShortDescription to accept boolean argument * Removed Globals.prefs from tests and removed unused imports * Unused import * Unused import Rewrite MedlineImporter with JAXB and add nbib fields (JabRef#1479) Add test in BibEntryWriterTest for type change When clicking on a tab, the first field now has the focus (JabRef#988) * the first Field does now have focus when clicking on a tab in the entry editor * Make first field focused when selecting a tab in entry editor The field list gets the focus as soon as it is focused (JabRef#1541) Test CustomImporter (JabRef#1501) * Test CustomImporter Fixes imports Added model.entry.FieldName that contains field name constants (JabRef#1602) * Added model.entry.FieldName that contains field name constants * More constants * Renamed and added more constants * Some more fields and cleanups * Removed MedlineHandler left from merge conflicts More fields added to FieldName (JabRef#1614) * More fields added to FieldName * Some Medline fixes [WIP] Create new fetcher infrastructure (JabRef#1594) * Introduce new Fetcher interfaces * Refactor arXiv fulltext fetcher * Add query based arXiv fetcher * Reformat code * Add a few tests for the arxiv parser * Make new arXiv fetcher available * Fix small problems related to files * Fix tests * Rename interface methods * Add changelog entry * Mark old EntryFetcher interface as deprecated * Move fetcher to importer \ fetcher * Move HelpFile from gui.help to logic.help * Rename fetchers * Rename FulltextFinder * Optimize imports * Fix failing test * Ignore failing test Added LayoutFormatterPreferences (and related files) (JabRef#1608) * Added LayoutFormatterPreferences (and related files) * Rebased * Included JournalAbbreviationLoader in LayoutPreferences Added more fields and fixed some issues (JabRef#1617) Resolves JabRef#1613 Use Jabref default icon for uninstaller for now (JabRef#1616) Always use https for help files (JabRef#1615) Implemented JabRef#1345 - cleanup ISSN (JabRef#1590) * Implemented JabRef#1345 - cleanup ISSN * Fixed comments * Extracted ISSN class * Added tests for ISSN and ISBN Added DateFormatter to LayoutEntry so that it actually works... (JabRef#1619) Converted a few getField to getFieldOptional (JabRef#1625) * Converted a few getField to getFieldOptional Fixed JabRef#636 by using DOICheck and DOIStrip in export filters (JabRef#1624) Improved LaTeX to Unicode/HTML formatters to output more sensible values for unknown commands (JabRef#1622) Updated preview entries (JabRef#1606) * Updated preview entries, which return new entry Moved, removed, and used String constants (JabRef#1618) * Moved, removed, and used String constants * Some more fixes * Moved NEWLINE, made FILE_SEPARATOR public and used it * Moved NEWLINE and FILE_SEPARATOR to OS * Moved ENCODING_PREFIX and SIGNATURE * Corrected Globals in a few comments... * Apparently the localization tests find commented out text... More field names and a method (JabRef#1627) * Introduced FieldName in ArXiV * Some more field names * More field names Cleanup FindFile and asssociated tests (JabRef#1596) * Cleanup FindFile and rework it using Streams and nio methods- * Unignore test for trying on CI * Use explicit List and Set in findFiles and caller methods * Use Lazy Stream to find files changes should be tested manually Some enhancements and cleanups related to dates (JabRef#1575) * Some enhancements and cleanups related to dates * Fixed some time zone issues * Replaced SimpleDateFormat in ZipFileChooser and replaced arrays with Lists * Changed EasyDateFormat constructors * Fixed stupid mistake * Added CHANGELOG entry * Maybe tests are passing now? * Some server side print debugging... * As it should be * Tryng LocalDateTime * No time zone * Added test for Cookie * Fixed imports... * Added a third possible date format as it turns out that the server changed while developing this PR Builds are now stored via build-upload.jabref.org Consistent file name casing (and other localization improvements) (JabRef#1629) * AUX files * ZIP files * BIB files * JAR files * didn't * Couldn't what's * Consistent casing * AUX apparently is commonly used in French words... * Fixed the flawed quick-and-dirty find-and-replace failures define xjc input/ouput dir (subsequent builds will be faster) (JabRef#1628) Execute task only when input/output dir changed. Fixed a minor issue and refactored MergeEntries (JabRef#1634) * Fixed a minor issue and refactored MergeEntries * Fixed import * Added CHANGELOG entry Added LabelPatternPreferences (JabRef#1607) * Added LabelPatternPreferences * Removed static initializer More tests (JabRef#1635) * Added more tests for Cookie * Enabled some layout tests and added test for StringUtil.intValueOfWithNull * Updated a test * Split tests Updated Errorprone to 2.0.11 (JabRef#1636) * Updated Errorprone to 2.0.11 * Corrected test Keep @comment text in a bib file (JabRef#1638) * Kep @comment text in a bib file * Add test for @comment that contains regular entries Replaced some getField and fixed some bugs (JabRef#1631) * Replaced some getField and fixed some bugs * Fixed a few things * Added CHANGELOG entries * Improved equals implementation * Text book equals and hashCode Fixed JabRef#1639 (JabRef#1641) * Fixed JabRef#1639 * Removed old code Export OO/LO citations to new database (JabRef#1630) * Export OO/LO citations to new database * Fixed problem with duplicates * Added some comments * Fixed spelling in comment * Removed general Exception Unified some equals (JabRef#1640) * Unified some equals * Imported correct Objects... Fixed one more NPE which should have been fixed in JabRef#1631 (JabRef#1649) Finished method to hide visible fields and show hidden fields - Hide method done - Show method done - ToDo repaint hidden field - ToDo test class finished field repaint remove sysouts

oscargus added component: cleanup-ops dev: code-quality Issues related to code or architecture decisions labels Jul 18, 2016

oscargus force-pushed the fieldnames branch from 37d625b to bf50d38 Compare July 20, 2016 08:20

oscargus changed the title ~~[WIP] Added model.entry.FieldName that contains field name constants~~ Added model.entry.FieldName that contains field name constants Jul 20, 2016

oscargus added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jul 20, 2016

oscargus mentioned this pull request Jul 20, 2016

Updated preview entries #1606

Merged

oscargus force-pushed the fieldnames branch from f5ab1d3 to d1aaebf Compare July 21, 2016 12:44

oscargus added 5 commits July 21, 2016 14:52

Added model.entry.FieldName that contains field name constants

7e8fc4c

More constants

4b46bbb

Renamed and added more constants

430f431

Some more fields and cleanups

c7493d5

Removed MedlineHandler left from merge conflicts

372b6b1

oscargus force-pushed the fieldnames branch from 9383c12 to 372b6b1 Compare July 21, 2016 12:53

oscargus merged commit 32319ff into JabRef:master Jul 21, 2016

oscargus deleted the fieldnames branch July 21, 2016 13:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added model.entry.FieldName that contains field name constants#1602

Added model.entry.FieldName that contains field name constants#1602
oscargus merged 5 commits into
JabRef:masterfrom
oscargus:fieldnames

oscargus commented Jul 18, 2016

Uh oh!

tobiasdiez commented Jul 19, 2016 •

edited

Loading

Uh oh!

matthiasgeiger commented Jul 19, 2016

Uh oh!

simonharrer commented Jul 19, 2016

Uh oh!

tobiasdiez commented Jul 19, 2016 •

edited

Loading

Uh oh!

Siedlerchr commented Jul 19, 2016

Uh oh!

simonharrer commented Jul 19, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

simonharrer commented Jul 21, 2016

Uh oh!

matthiasgeiger commented Jul 21, 2016

Uh oh!

oscargus commented Jul 21, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

oscargus commented Jul 18, 2016

Uh oh!

tobiasdiez commented Jul 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matthiasgeiger commented Jul 19, 2016

Uh oh!

simonharrer commented Jul 19, 2016

Uh oh!

tobiasdiez commented Jul 19, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Siedlerchr commented Jul 19, 2016

Uh oh!

simonharrer commented Jul 19, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

oscargus commented Jul 20, 2016

Uh oh!

simonharrer commented Jul 21, 2016

Uh oh!

matthiasgeiger commented Jul 21, 2016

Uh oh!

oscargus commented Jul 21, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tobiasdiez commented Jul 19, 2016 •

edited

Loading

tobiasdiez commented Jul 19, 2016 •

edited

Loading