JabRef 5.15 · org.jabref.logic.importer.fetcher.transformers.AbstractQueryTransformer

Modifier and Type	Field and Description
protected int	endYear
private static final Logger	LOGGER
public static final String	NO_EXPLICIT_FIELD
protected int	startYear

Access	Constructor and Description
public	AbstractQueryTransformer()

Method Summary

Modifier and Type	Method and Description
protected String	createKeyValuePair(String fieldAsString, String term)
protected String	createKeyValuePair(String fieldAsString, String term, String separator)
protected abstract String	getLogicalAndOperator() Returns the logical AND operator used by the library Note: whitespaces have to be included around the operator Example: `" AND "`
protected abstract String	getLogicalNotOperator() Returns the logical NOT operator used by the library Example: `"!"`
protected abstract String	getLogicalOrOperator() Returns the logical OR operator used by the library Note: whitespaces have to be included around the operator Example: `" OR "`
protected abstract String	handleAuthor(String author) Return a string representation of the author fielded term
protected String	handleDoi(String term)
protected abstract String	handleJournal(String journalTitle) Return a string representation of the journal fielded term
protected Optional<String>	handleOtherField(String fieldAsString, String term) Return a string representation of the provided field If it is not supported return an empty optional.
protected abstract String	handleTitle(String title) Return a string representation of the title fielded term
protected Optional<String>	handleUnFieldedTerm(String term) Return a string representation of the un-fielded (default fielded) term Default implementation: just return the term (in quotes if a space is contained)
protected abstract String	handleYear(String year) Return a string representation of the year fielded term
protected String	handleYearRange(String yearRange) Return a string representation of the year-range fielded term Should follow the structure yyyy-yyyy Example: `2015-2021`
protected void	parseYearRange(String yearRange) Parses the year range and fills startYear and endYear.
private String	removeOuterBraces(String query) Removes the outer braces as they are unnecessary
protected Optional<String>	transform(org.apache.lucene.queryparser.flexible.core.nodes.BooleanQueryNode query) Transforms a and b and c to (a AND b AND c), where a, b, and c can be complex expressions.
private Optional<String>	transform(org.apache.lucene.queryparser.flexible.core.nodes.FieldQueryNode query)
private Optional<String>	transform(org.apache.lucene.queryparser.flexible.core.nodes.ModifierQueryNode query) Handles the not modifier, all other cases are silently ignored
protected Optional<String>	transform(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode query)
public Optional<String>	Returns: A query string containing all fields that are contained in the original lucene query and that are expressible in the library specific query language, other information either is discarded or stored as part of the state of the transformer if it can be used e.g. as a URL parameter for the query. transformLuceneQuery(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode The lucene query tp transform luceneQuery) Parses the given query string into a complex query using lucene.

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

endYear	back to summary
protected int endYear

LOGGER	back to summary
private static final Logger LOGGER

NO_EXPLICIT_FIELD	back to summary
public static final String NO_EXPLICIT_FIELD

startYear	back to summary
protected int startYear

AbstractQueryTransformer	back to summary
public AbstractQueryTransformer()

Method Detail

createKeyValuePair	back to summary
protected String createKeyValuePair(String fieldAsString, String term)

createKeyValuePair	back to summary
protected String createKeyValuePair(String fieldAsString, String term, String separator)

getLogicalAndOperator	back to summary
protected abstract String getLogicalAndOperator() Returns the logical AND operator used by the library Note: whitespaces have to be included around the operator Example: `" AND "`

getLogicalNotOperator	back to summary
protected abstract String getLogicalNotOperator() Returns the logical NOT operator used by the library Example: `"!"`

getLogicalOrOperator	back to summary
protected abstract String getLogicalOrOperator() Returns the logical OR operator used by the library Note: whitespaces have to be included around the operator Example: `" OR "`

handleAuthor	back to summary
protected abstract String handleAuthor(String author) Return a string representation of the author fielded term

handleDoi	back to summary
protected String handleDoi(String term)

handleJournal	back to summary
protected abstract String handleJournal(String journalTitle) Return a string representation of the journal fielded term

handleOtherField	back to summary
protected Optional<String> handleOtherField(String fieldAsString, String term) Return a string representation of the provided field If it is not supported return an empty optional.

handleTitle	back to summary
protected abstract String handleTitle(String title) Return a string representation of the title fielded term

handleUnFieldedTerm	back to summary
protected Optional<String> handleUnFieldedTerm(String term) Return a string representation of the un-fielded (default fielded) term Default implementation: just return the term (in quotes if a space is contained)

handleUnFieldedTerm

back to summary

protected Optional<String> handleUnFieldedTerm(String term)

Return a string representation of the un-fielded (default fielded) term

Default implementation: just return the term (in quotes if a space is contained)

handleYear	back to summary
protected abstract String handleYear(String year) Return a string representation of the year fielded term

handleYearRange	back to summary
protected String handleYearRange(String yearRange) Return a string representation of the year-range fielded term Should follow the structure yyyy-yyyy Example: `2015-2021`

parseYearRange	back to summary
protected void parseYearRange(String yearRange) Parses the year range and fills startYear and endYear. Ensures that startYear <= endYear

removeOuterBraces	back to summary
private String removeOuterBraces(String query) Removes the outer braces as they are unnecessary

transform	back to summary
protected Optional<String> transform(org.apache.lucene.queryparser.flexible.core.nodes.BooleanQueryNode query) Transforms a and b and c to (a AND b AND c), where a, b, and c can be complex expressions.

transform	back to summary
private Optional<String> transform(org.apache.lucene.queryparser.flexible.core.nodes.FieldQueryNode query)

transform	back to summary
private Optional<String> transform(org.apache.lucene.queryparser.flexible.core.nodes.ModifierQueryNode query) Handles the not modifier, all other cases are silently ignored

transform	back to summary
protected Optional<String> transform(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode query)

transformLuceneQuery	back to summary
public Optional<String> transformLuceneQuery(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode luceneQuery) Parses the given query string into a complex query using lucene. Note For unique fields, the alphabetically and numerically first instance in the query string is used in the complex query. Parameters luceneQuery:org.apache.lucene.queryparser.flexible.core.nodes.QueryNode The lucene query tp transform Returns:Optional<String> A query string containing all fields that are contained in the original lucene query and that are expressible in the library specific query language, other information either is discarded or stored as part of the state of the transformer if it can be used e.g. as a URL parameter for the query.

transformLuceneQuery

back to summary

public Optional<String> transformLuceneQuery(org.apache.lucene.queryparser.flexible.core.nodes.QueryNode luceneQuery)

Parses the given query string into a complex query using lucene.

Note

For unique fields, the alphabetically and numerically first instance in the query string is used in the complex query.

Parameters

luceneQuery:org.apache.lucene.queryparser.flexible.core.nodes.QueryNode: The lucene query tp transform

Returns:Optional<String>

A query string containing all fields that are contained in the original lucene query and that are expressible in the library specific query language, other information either is discarded or stored as part of the state of the transformer if it can be used e.g. as a URL parameter for the query.

public abstract Class AbstractQueryTransformer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail