ExplicitGroup (JabRef API)

java.lang.Object
- net.sf.jabref.groups.AbstractGroup
- - net.sf.jabref.groups.ExplicitGroup

All Implemented Interfaces:: SearchRule

public class ExplicitGroup
extends AbstractGroup
implements SearchRule

Author:: jzieren

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ID
- Fields inherited from class net.sf.jabref.groups.AbstractGroup
  INCLUDING, INDEPENDENT, m_context, m_name, QUOTE_CHAR, REFINING, SEPARATOR

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID`

Constructor Summary

Constructors
Constructor and Description

ExplicitGroup(java.lang.String name, int context)

Constructors
Constructor and Description
`ExplicitGroup(java.lang.String name, int context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.swing.undo.AbstractUndoableEdit`	`add(BibtexEntry[] entries)` Adds the specified entries to this group.
`protected void`	`addEntries(QuotedStringTokenizer tok, BibtexDatabase db)` Called only when created fromString
`boolean`	`addEntry(BibtexEntry entry)`
`int`	`applyRule(java.util.Map<java.lang.String,java.lang.String> searchStrings, BibtexEntry bibtexEntry)`
`void`	`clearAssignments()` Remove all assignments, resulting in an empty group.
`boolean`	`contains(BibtexEntry entry)`
`boolean`	`contains(java.util.Map<java.lang.String,java.lang.String> searchOptions, BibtexEntry entry)`
`AbstractGroup`	`deepCopy()`
`boolean`	`equals(java.lang.Object o)`
`static AbstractGroup`	`fromString(java.lang.String s, BibtexDatabase db, int version)`
`java.lang.String`	`getDescription()` Returns a lengthy textual description of this instance (for the groups editor).
`static java.lang.String`	`getDescriptionForPreview()`
`java.util.Set<BibtexEntry>`	`getEntries()`
`int`	`getNumEntries()`
`SearchRule`	`getSearchRule()`
`java.lang.String`	`getShortDescription()` Returns a short description of the group in HTML (for a tooltip).
`java.lang.String`	`getTypeId()`
`boolean`	`isDynamic()` Returns true if this group is dynamic, i.e.
`void`	`refreshForNewDatabase(BibtexDatabase db)` Update the group to handle the situation where the group is applied to a different BibtexDatabase than it was created for.
`javax.swing.undo.AbstractUndoableEdit`	`remove(BibtexEntry[] entries)` Removes the specified entries from this group.
`boolean`	`removeEntry(BibtexEntry entry)`
`boolean`	`supportsAdd()`
`boolean`	`supportsRemove()`
`java.lang.String`	`toString()` Returns a String representation of this group and its entries.
`boolean`	`validateSearchStrings(java.util.Map<java.lang.String,java.lang.String> searchStrings)`

Methods inherited from class net.sf.jabref.groups.AbstractGroup
containsAll, containsAny, getHierarchicalContext, getName, setHierarchicalContext, setName

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExplicitGroup
```
public ExplicitGroup(java.lang.String name,
                     int context)
```
- Method Detail
  - fromString
```
public static AbstractGroup fromString(java.lang.String s,
                                       BibtexDatabase db,
                                       int version)
                                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - addEntries
```
protected void addEntries(QuotedStringTokenizer tok,
                          BibtexDatabase db)
```
    Called only when created fromString
  - getSearchRule
```
public SearchRule getSearchRule()
```
    Specified by:
    
    getSearchRule in class AbstractGroup
    
    Returns:
    
    A search rule that will identify this group's entries.
  - supportsAdd
```
public boolean supportsAdd()
```
    Specified by:
    
    supportsAdd in class AbstractGroup
    
    Returns:
    
    true if this type of group supports the explicit adding of entries.
  - supportsRemove
```
public boolean supportsRemove()
```
    Specified by:
    
    supportsRemove in class AbstractGroup
    
    Returns:
    
    true if this type of group supports the explicit removal of entries.
  - add
```
public javax.swing.undo.AbstractUndoableEdit add(BibtexEntry[] entries)
```
    Description copied from class: AbstractGroup
    
    Adds the specified entries to this group.
    
    Specified by:
    
    add in class AbstractGroup
    
    Returns:
    
    If this group or one or more entries was/were modified as a result of this operation, an object is returned that allows to undo this change. null is returned otherwise.
  - addEntry
```
public boolean addEntry(BibtexEntry entry)
```
  - remove
```
public javax.swing.undo.AbstractUndoableEdit remove(BibtexEntry[] entries)
```
    Description copied from class: AbstractGroup
    
    Removes the specified entries from this group.
    
    Specified by:
    
    remove in class AbstractGroup
    
    Returns:
    
    If this group or one or more entries was/were modified as a result of this operation, an object is returned that allows to undo this change. null is returned otherwise.
  - removeEntry
```
public boolean removeEntry(BibtexEntry entry)
```
  - contains
```
public boolean contains(BibtexEntry entry)
```
    Specified by:
    
    contains in class AbstractGroup
    
    Returns:
    
    true if this group contains the specified entry, false otherwise.
  - contains
```
public boolean contains(java.util.Map<java.lang.String,java.lang.String> searchOptions,
                        BibtexEntry entry)
```
    Specified by:
    
    contains in class AbstractGroup
    
    Parameters:
    
    searchOptions - The search options to apply.
    
    Returns:
    
    true if this group contains the specified entry, false otherwise.
  - applyRule
```
public int applyRule(java.util.Map<java.lang.String,java.lang.String> searchStrings,
                     BibtexEntry bibtexEntry)
```
    Specified by:
    
    applyRule in interface SearchRule
  - validateSearchStrings
```
public boolean validateSearchStrings(java.util.Map<java.lang.String,java.lang.String> searchStrings)
```
    Specified by:
    
    validateSearchStrings in interface SearchRule
  - deepCopy
```
public AbstractGroup deepCopy()
```
    Specified by:
    
    deepCopy in class AbstractGroup
    
    Returns:
    
    A deep copy of this object.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this group and its entries. Entries are referenced by their Bibtexkey. Entries that do not have a Bibtexkey are not included in the representation and will thus not be available upon recreation.
    
    Overrides:
    
    toString in class java.lang.Object
  - clearAssignments
```
public void clearAssignments()
```
    Remove all assignments, resulting in an empty group.
  - isDynamic
```
public boolean isDynamic()
```
    Description copied from class: AbstractGroup
    
    Returns true if this group is dynamic, i.e. uses a search definition or equiv. that might match new entries, or false if this group contains a fixed set of entries and thus will never match a new entry that was not explicitly added to it.
    
    Specified by:
    
    isDynamic in class AbstractGroup
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from class: AbstractGroup
    
    Returns a lengthy textual description of this instance (for the groups editor). The text is formatted in HTML.
    
    Specified by:
    
    getDescription in class AbstractGroup
  - getDescriptionForPreview
```
public static java.lang.String getDescriptionForPreview()
```
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Description copied from class: AbstractGroup
    
    Returns a short description of the group in HTML (for a tooltip).
    
    Specified by:
    
    getShortDescription in class AbstractGroup
  - refreshForNewDatabase
```
public void refreshForNewDatabase(BibtexDatabase db)
```
    Update the group to handle the situation where the group is applied to a different BibtexDatabase than it was created for. This group type contains a Set of BibtexEntry objects, and these will not be the same objects as in the new database. We must reset the entire Set with matching entries from the new database.
    
    Overrides:
    
    refreshForNewDatabase in class AbstractGroup
    
    Parameters:
    
    db - The database to refresh for.
  - getEntries
```
public java.util.Set<BibtexEntry> getEntries()
```
  - getTypeId
```
public java.lang.String getTypeId()
```
    Specified by:
    
    getTypeId in class AbstractGroup
  - getNumEntries
```
public int getNumEntries()
```

Class ExplicitGroup

Field Summary

Fields inherited from class net.sf.jabref.groups.AbstractGroup

Constructor Summary

Method Summary

Methods inherited from class net.sf.jabref.groups.AbstractGroup

Methods inherited from class java.lang.Object

Field Detail

ID

Constructor Detail

ExplicitGroup

Method Detail

fromString

addEntries

getSearchRule

supportsAdd

supportsRemove

add

addEntry

remove

removeEntry

contains

contains

applyRule

validateSearchStrings

deepCopy

equals

toString

clearAssignments

isDynamic

getDescription

getDescriptionForPreview

getShortDescription

refreshForNewDatabase

getEntries

getTypeId

getNumEntries