net.sf.jabref

Class CustomEntryType

java.lang.Object

net.sf.jabref.BibtexEntryType

net.sf.jabref.CustomEntryType

All Implemented Interfaces:

java.lang.Comparable<BibtexEntryType>

public class CustomEntryType
extends BibtexEntryType

This class is used to represent customized entry types.

Field Summary

Fields inherited from class net.sf.jabref.BibtexEntryType

ALL_TYPES, ARTICLE, BOOK, BOOKLET, CONFERENCE, ELECTRONIC, IEEETRANBSTCTL, INBOOK, INCOLLECTION, INPROCEEDINGS, MANUAL, MASTERSTHESIS, MISC, OTHER, PATENT, PERIODICAL, PHDTHESIS, PROCEEDINGS, STANDARD, STANDARD_TYPES, TECHREPORT, TYPELESS, UNPUBLISHED

Constructor Summary

Constructors

Constructor and Description
CustomEntryType(java.lang.String name_, java.lang.String[] req_, java.lang.String[] opt_)
CustomEntryType(java.lang.String name_, java.lang.String[] req_, java.lang.String[] opt_, java.lang.String[] opt2_)
CustomEntryType(java.lang.String name_, java.lang.String reqStr, java.lang.String optStr)

Method Summary

Modifier and Type	Method and Description
java.lang.String	describeOptionalFields()
java.lang.String	describeRequiredFields()
java.lang.String	getName()
java.lang.String[]	getOptionalFields()
java.lang.String[]	getPrimaryOptionalFields()
java.lang.String[]	getRequiredFields()
java.lang.String[]	getRequiredFieldsForCustomization() Get an array of the required fields in a form appropriate for the entry customization dialog - that is, thie either-or fields together and separated by slashes.
java.lang.String	getRequiredFieldsString() Get a String describing the required field set for this entry type.
boolean	hasAllRequiredFields(BibtexEntry entry, BibtexDatabase database) Check whether this entry's required fields are set, taking crossreferenced entries and either-or fields into account:
protected boolean	isCoupledFieldSet(java.lang.String field, BibtexEntry entry, BibtexDatabase database)
static CustomEntryType	parseEntryType(java.lang.String comment)
protected void	parseRequiredFields(java.lang.String reqStr)
protected void	parseRequiredFields(java.lang.String[] parts)
void	save(java.io.Writer out)

Methods inherited from class net.sf.jabref.BibtexEntryType

compareTo, getStandardType, getType, getUtilityFields, isOptional, isRequired, isVisibleAtNewEntryDialog, loadCustomEntryTypes, removeType, saveCustomEntryTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomEntryType

public CustomEntryType(java.lang.String name_,
                       java.lang.String[] req_,
                       java.lang.String[] opt_,
                       java.lang.String[] opt2_)

CustomEntryType

public CustomEntryType(java.lang.String name_,
                       java.lang.String[] req_,
                       java.lang.String[] opt_)

CustomEntryType

public CustomEntryType(java.lang.String name_,
                       java.lang.String reqStr,
                       java.lang.String optStr)

Method Detail

parseRequiredFields

protected void parseRequiredFields(java.lang.String reqStr)

parseRequiredFields

protected void parseRequiredFields(java.lang.String[] parts)

getName

public java.lang.String getName()

Specified by:

getName in class BibtexEntryType

getOptionalFields

public java.lang.String[] getOptionalFields()

Specified by:

getOptionalFields in class BibtexEntryType

getRequiredFields

public java.lang.String[] getRequiredFields()

Specified by:

getRequiredFields in class BibtexEntryType

getPrimaryOptionalFields

public java.lang.String[] getPrimaryOptionalFields()

Overrides:

getPrimaryOptionalFields in class BibtexEntryType

getRequiredFieldsForCustomization

public java.lang.String[] getRequiredFieldsForCustomization()

Description copied from class: BibtexEntryType

Get an array of the required fields in a form appropriate for the entry customization dialog - that is, thie either-or fields together and separated by slashes.

Overrides:

getRequiredFieldsForCustomization in class BibtexEntryType

Returns:

Array of the required fields in a form appropriate for the entry customization dialog.

describeRequiredFields

public java.lang.String describeRequiredFields()

Specified by:

describeRequiredFields in class BibtexEntryType

describeOptionalFields

public java.lang.String describeOptionalFields()

hasAllRequiredFields

public boolean hasAllRequiredFields(BibtexEntry entry,
                                    BibtexDatabase database)

Check whether this entry's required fields are set, taking crossreferenced entries and either-or fields into account:

Specified by:

hasAllRequiredFields in class BibtexEntryType

Parameters:

entry - The entry to check.

database - The entry's database.

Returns:

True if required fields are set, false otherwise.

isCoupledFieldSet

protected boolean isCoupledFieldSet(java.lang.String field,
                                    BibtexEntry entry,
                                    BibtexDatabase database)

getRequiredFieldsString

public java.lang.String getRequiredFieldsString()

Get a String describing the required field set for this entry type.

Returns:

Description of required field set for storage in preferences or bib file.

save

public void save(java.io.Writer out)
          throws java.io.IOException

Throws:

java.io.IOException

parseEntryType

public static CustomEntryType parseEntryType(java.lang.String comment)