-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactored Singlebibtexfield #979
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
167 changes: 167 additions & 0 deletions
167
src/main/java/net/sf/jabref/bibtex/BibtexSingleField.java
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
package net.sf.jabref.bibtex; | ||
|
||
import java.util.EnumSet; | ||
import java.util.Set; | ||
|
||
/** | ||
* | ||
* Class for keeping properties of a single BibTeX/BibLatex field | ||
* | ||
*/ | ||
public class BibtexSingleField { | ||
|
||
// some field constants | ||
public static final double DEFAULT_FIELD_WEIGHT = 1; | ||
public static final double MAX_FIELD_WEIGHT = 2; | ||
|
||
public static final double SMALL_W = 0.30; | ||
public static final double MEDIUM_W = 0.5; | ||
public static final double LARGE_W = 1.5; | ||
|
||
public static final int DEFAULT_FIELD_LENGTH = 100; | ||
|
||
|
||
private enum Flag { | ||
STANDARD, | ||
PRIVATE, | ||
DISPLAYABLE, | ||
WRITEABLE; | ||
} | ||
|
||
|
||
// the field name | ||
private final String name; | ||
|
||
// contains the standard, private, displayable, writable infos | ||
// default is: not standard, public, displayable and writable | ||
private final Set<Flag> flags = EnumSet.of(Flag.DISPLAYABLE, Flag.WRITEABLE); | ||
|
||
private int length = DEFAULT_FIELD_LENGTH; | ||
private double weight = DEFAULT_FIELD_WEIGHT; | ||
|
||
// the extras data | ||
// fieldExtras contains mappings to tell the EntryEditor to add a specific | ||
// function to this field, for instance a "browse" button for the "pdf" field. | ||
private Set<BibtexSingleFieldProperties> extras = EnumSet.noneOf(BibtexSingleFieldProperties.class); | ||
|
||
// a comma separated list of alternative bibtex-fieldnames, e.g. | ||
// "LCCN" is the same like "lib-congress" | ||
// private String otherNames = null ; | ||
|
||
public BibtexSingleField(String fieldName, boolean pStandard) { | ||
name = fieldName; | ||
setFlag(pStandard, Flag.STANDARD); | ||
} | ||
|
||
public BibtexSingleField(String fieldName, boolean pStandard, double pWeight) { | ||
name = fieldName; | ||
setFlag(pStandard, Flag.STANDARD); | ||
weight = pWeight; | ||
} | ||
|
||
public BibtexSingleField(String fieldName, boolean pStandard, int pLength) { | ||
name = fieldName; | ||
setFlag(pStandard, Flag.STANDARD); | ||
length = pLength; | ||
} | ||
|
||
public BibtexSingleField(String fieldName, boolean pStandard, double pWeight, int pLength) { | ||
name = fieldName; | ||
setFlag(pStandard, Flag.STANDARD); | ||
weight = pWeight; | ||
length = pLength; | ||
} | ||
|
||
/** | ||
* Sets or onsets the given flag | ||
* @param setToOn if true, set the flag; if false, unset the flat | ||
* @param flagID, the id of the flag | ||
*/ | ||
private void setFlag(boolean setToOn, Flag flagID) { | ||
if (setToOn) { | ||
// set the flag | ||
flags.add(flagID); | ||
} else { | ||
// unset the flag | ||
flags.remove(flagID); | ||
} | ||
} | ||
|
||
public boolean isStandard() { | ||
return flags.contains(Flag.STANDARD); | ||
} | ||
|
||
public void setPrivate() { | ||
flags.add(Flag.PRIVATE); | ||
} | ||
|
||
public boolean isPrivate() { | ||
return flags.contains(Flag.PRIVATE); | ||
} | ||
|
||
public void setDisplayable(boolean value) { | ||
setFlag(value, Flag.DISPLAYABLE); | ||
} | ||
|
||
public boolean isDisplayable() { | ||
return flags.contains(Flag.DISPLAYABLE); | ||
} | ||
|
||
public void setWriteable(boolean value) { | ||
setFlag(value, Flag.WRITEABLE); | ||
} | ||
|
||
public boolean isWriteable() { | ||
return flags.contains(Flag.WRITEABLE); | ||
} | ||
|
||
public void setExtras(Set<BibtexSingleFieldProperties> pExtras) { | ||
extras = pExtras; | ||
} | ||
|
||
// fieldExtras contains mappings to tell the EntryEditor to add a specific | ||
// function to this field, for instance a "browse" button for the "pdf" field. | ||
public Set<BibtexSingleFieldProperties> getExtras() { | ||
return extras; | ||
} | ||
|
||
public void setWeight(double value) { | ||
this.weight = value; | ||
} | ||
|
||
public double getWeight() { | ||
return this.weight; | ||
} | ||
|
||
/** | ||
* @return The maximum (expected) length of the field value; <em>not</em> the length of the field name | ||
*/ | ||
public int getLength() { | ||
return this.length; | ||
} | ||
|
||
public String getFieldName() { | ||
return name; | ||
} | ||
|
||
/** | ||
* Set this field's numeric property | ||
* | ||
* @param numeric true to indicate that this is a numeric field. | ||
* @return this BibtexSingleField instance. Makes it easier to call this | ||
* method on the fly while initializing without using a local variable. | ||
*/ | ||
public BibtexSingleField setNumeric(boolean numeric) { | ||
if (numeric) { | ||
extras.add(BibtexSingleFieldProperties.NUMERIC); | ||
} else { | ||
extras.remove(BibtexSingleFieldProperties.NUMERIC); | ||
} | ||
return this; | ||
} | ||
|
||
public boolean isNumeric() { | ||
return extras.contains(BibtexSingleFieldProperties.NUMERIC); | ||
} | ||
|
||
} |
20 changes: 20 additions & 0 deletions
20
src/main/java/net/sf/jabref/bibtex/BibtexSingleFieldProperties.java
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package net.sf.jabref.bibtex; | ||
|
||
import java.util.EnumSet; | ||
|
||
public enum BibtexSingleFieldProperties { | ||
YES_NO, | ||
URL, | ||
DATEPICKER, | ||
JOURNAL_NAMES, | ||
EXTERNAL, | ||
BROWSE, | ||
SET_OWNER, | ||
MONTH, | ||
FILE_EDITOR, | ||
NUMERIC; | ||
|
||
public static final EnumSet<BibtexSingleFieldProperties> ALL_OPTS = EnumSet | ||
.allOf(BibtexSingleFieldProperties.class); | ||
|
||
} |
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it be possible to only set the flags in the constructor and not allow it to be changed later?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possibly. However, the way the current code looks it is a bit of work and since this is primarily used for the special fields, I think it is better to wait until that is reworked.