Modifier and Type	Class and Description
public static class	ComplexSearchQuery.ComplexSearchQueryBuilder

Access	Constructor and Description
private	ComplexSearchQuery(List<String> defaultField, List<String> authors, List<String> titlePhrases, List<String> abstractPhrases, Integer fromYear, Integer toYear, Integer singleYear, String journal, String doi)

Method Summary

Modifier and Type	Method and Description
public static ComplexSearchQuery.ComplexSearchQueryBuilder	builder()
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static ComplexSearchQuery	fromTerms(List<org.apache.lucene.index.Term> terms)
public List<String>	getAbstractPhrases()
public List<String>	getAuthors()
public List<String>	getDefaultFieldPhrases()
public Optional<String>	getDOI()
public Optional<Integer>	getFromYear()
public Optional<String>	getJournal()
public Optional<Integer>	getSingleYear()
public List<String>	getTitlePhrases()
public Optional<Integer>	getToYear()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

abstractPhrases	back to summary
private final List<String> abstractPhrases

authors	back to summary
private final List<String> authors

defaultField	back to summary
private final List<String> defaultField

doi	back to summary
private final String doi

fromYear	back to summary
private final Integer fromYear

journal	back to summary
private final String journal

singleYear	back to summary
private final Integer singleYear

titlePhrases	back to summary
private final List<String> titlePhrases

toYear	back to summary
private final Integer toYear

Constructor Detail

ComplexSearchQuery	back to summary
private ComplexSearchQuery(List<String> defaultField, List<String> authors, List<String> titlePhrases, List<String> abstractPhrases, Integer fromYear, Integer toYear, Integer singleYear, String journal, String doi)

Method Detail

builder	back to summary
public static ComplexSearchQuery.ComplexSearchQueryBuilder builder()

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

fromTerms	back to summary
public static ComplexSearchQuery fromTerms(List<org.apache.lucene.index.Term> terms)

getAbstractPhrases	back to summary
public List<String> getAbstractPhrases()

getAuthors	back to summary
public List<String> getAuthors()

getDefaultFieldPhrases	back to summary
public List<String> getDefaultFieldPhrases()

getDOI	back to summary
public Optional<String> getDOI()

getFromYear	back to summary
public Optional<Integer> getFromYear()

getJournal	back to summary
public Optional<String> getJournal()

getSingleYear	back to summary
public Optional<Integer> getSingleYear()

getTitlePhrases	back to summary
public List<String> getTitlePhrases()

getToYear	back to summary
public Optional<Integer> getToYear()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.jabref.logic.importer.fetcher back to summary

public Class ComplexSearchQuery.ComplexSearchQueryBuilder

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.importer.fetcher.ComplexSearchQuery.ComplexSearchQueryBuilder

Field Summary

Modifier and Type	Field and Description
private final List<String>	abstractPhrases
private final List<String>	authors
private final List<String>	defaultFieldPhrases
private String	doi
private Integer	fromYear
private String	journal
private Integer	singleYear
private final List<String>	titlePhrases
private Integer	toYear

Constructor Summary

Access	Constructor and Description
private	ComplexSearchQueryBuilder()

Method Summary

Modifier and Type	Method and Description
public ComplexSearchQuery.ComplexSearchQueryBuilder	abstractPhrase(String abstractPhrase) Adds abstract phrase and wraps it in quotes
public ComplexSearchQuery.ComplexSearchQueryBuilder	author(String author) Adds author and wraps it in quotes
public ComplexSearchQuery	Returns: ComplexSearchQuery instance with the fields set to the values defined in the building instance. build() Instantiates the AdvancesSearchConfig from the provided Builder parameters If all text fields are empty an empty optional is returned
public ComplexSearchQuery.ComplexSearchQueryBuilder	defaultFieldPhrase(String defaultFieldPhrase)
public ComplexSearchQuery.ComplexSearchQueryBuilder	DOI(String doi)
public ComplexSearchQuery.ComplexSearchQueryBuilder	fromYearAndToYear(Integer fromYear, Integer toYear)
public ComplexSearchQuery.ComplexSearchQueryBuilder	journal(String journal)
pack-priv void	parseYearRange(String termText)
public ComplexSearchQuery.ComplexSearchQueryBuilder	singleYear(Integer singleYear)
private boolean	stringListIsBlank(List<String> stringList)
public ComplexSearchQuery.ComplexSearchQueryBuilder	terms(Collection<org.apache.lucene.index.Term> terms)
private boolean	textSearchFieldsAndYearFieldsAreEmpty()
public ComplexSearchQuery.ComplexSearchQueryBuilder	titlePhrase(String titlePhrase) Adds title phrase and wraps it in quotes
private boolean	yearFieldsAreEmpty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

abstractPhrases	back to summary
private final List<String> abstractPhrases

authors	back to summary
private final List<String> authors

defaultFieldPhrases	back to summary
private final List<String> defaultFieldPhrases

doi	back to summary
private String doi

fromYear	back to summary
private Integer fromYear

journal	back to summary
private String journal

singleYear	back to summary
private Integer singleYear

titlePhrases	back to summary
private final List<String> titlePhrases

toYear	back to summary
private Integer toYear

Constructor Detail

ComplexSearchQueryBuilder	back to summary
private ComplexSearchQueryBuilder()

Method Detail

abstractPhrase	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder abstractPhrase(String abstractPhrase) Adds abstract phrase and wraps it in quotes

author	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder author(String author) Adds author and wraps it in quotes

build	back to summary
public ComplexSearchQuery build() throws IllegalStateException Instantiates the AdvancesSearchConfig from the provided Builder parameters If all text fields are empty an empty optional is returned Returns:ComplexSearchQuery ComplexSearchQuery instance with the fields set to the values defined in the building instance. Exceptions IllegalStateException: An IllegalStateException is thrown in case all text search fields are empty. See: https://softwareengineering.stackexchange.com/questions/241309/builder-pattern-when-to-fail/241320#241320

build

back to summary

public ComplexSearchQuery build() throws IllegalStateException

Instantiates the AdvancesSearchConfig from the provided Builder parameters If all text fields are empty an empty optional is returned

Returns:ComplexSearchQuery

ComplexSearchQuery instance with the fields set to the values defined in the building instance.

Exceptions

IllegalStateException:: An IllegalStateException is thrown in case all text search fields are empty. See: https://softwareengineering.stackexchange.com/questions/241309/builder-pattern-when-to-fail/241320#241320

defaultFieldPhrase	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder defaultFieldPhrase(String defaultFieldPhrase)

DOI	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder DOI(String doi)

fromYearAndToYear	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder fromYearAndToYear(Integer fromYear, Integer toYear)

journal	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder journal(String journal)

parseYearRange	back to summary
pack-priv void parseYearRange(String termText)

singleYear	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder singleYear(Integer singleYear)

stringListIsBlank	back to summary
private boolean stringListIsBlank(List<String> stringList)

terms	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder terms(Collection<org.apache.lucene.index.Term> terms)

textSearchFieldsAndYearFieldsAreEmpty	back to summary
private boolean textSearchFieldsAndYearFieldsAreEmpty()

titlePhrase	back to summary
public ComplexSearchQuery.ComplexSearchQueryBuilder titlePhrase(String titlePhrase) Adds title phrase and wraps it in quotes

yearFieldsAreEmpty	back to summary
private boolean yearFieldsAreEmpty()

public Class ComplexSearchQuery

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ComplexSearchQuery.ComplexSearchQueryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail