public class FilterRootElement extends Object
Used by FilterCommonRootSolrField. Based on CommonRootSolrField by sroseboo
Constructor and Description |
---|
FilterRootElement() |
Modifier and Type | Method and Description |
---|---|
String |
getCatalogQuery()
Get the 'catalogQuery' portion of a query filter
|
String |
getDelimiter()
Get the delimeter used to separate string tokens
|
FilterGroupProcessor |
getFilterGroup()
Get defined filter group processor
|
List<FilterProcessor> |
getFilters()
Get all defined filter processors
|
String |
getIdFilterMatch()
Get the terms used to identify a 'id' filter
|
String |
getIsPartOfFilterMatch()
Get the terms used to identify an 'isPartOf' filter
|
List<LeafElement> |
getLeafs()
Get the 'leaf' elements defined for a filter
|
String |
getName()
Set the name of this processor
|
String |
getRootValues(Object docOrNode)
Get the document processor values for the document or node
|
List<FilterRootElement> |
getSubRoots()
Get the children filter nodes
|
String |
getxPath()
Set the XPath of the filter node this processor operates on
|
XPathExpression |
getxPathExpression()
Return the xPath expression applied to the filter node that this processor operates on
|
void |
initXPathExpressions(XPath xPathObject)
Initialize the XPath object for XML node which includes all filters for
this collection document.
|
void |
setCatalogQuery(String catalogQuery)
Set the 'catalogQuery' portion of a query filter
|
void |
setDelimiter(String delimiter)
Set the delimeter used to separate string tokens
|
void |
setFilterGroup(FilterGroupProcessor filterGroup)
Get defined filter group processor
|
void |
setFilters(List<FilterProcessor> filters)
Get all defined filter processors
|
void |
setIdFilterMatch(String idFilterMatch)
Get the terms used to identify a 'id' filter
|
void |
setIsPartOfFilterMatch(String isPartOfMatch)
Set the terms used to identify an 'isPartOf' filter
|
void |
setLeafs(List<LeafElement> leafs)
Get the 'leaf' elements defined for a filter
|
void |
setName(String name)
Get the name of this processor
|
void |
setSubRoots(List<FilterRootElement> subRoots)
Set the children filter nodes
|
void |
setxPath(String xPath)
Return the XPath for filter nodes this processor operates on
|
void |
setxPathExpression(XPathExpression xPathExpression)
Set the xpath expression applied to the filter node that this processor operates on
|
public String getRootValues(Object docOrNode) throws XPathExpressionException
docOrNode
- - An XML document root or sub-node of a DataONE collection documentXPathExpressionException
- This method parses a DataONE collection document and builds a Solr query from the filters defined in the document. The filters define the set of DataONE pids that are of interest to the outhor of the collection (portal). The Solr query provides a way for client programs to fetch the same set of pids that are defined by the filters.
One example client use case for this Solr 'collectionQuery' field is to retrive all the pids for a collection and run metadata quality scores on them, to allow the portal users to determine the quality of the metadata for their collection.
public void initXPathExpressions(XPath xPathObject)
xPathObject
- the XPath object which includes all filters to processpublic String getName()
public void setName(String name)
name
- the name of this processorpublic String getxPath()
public void setxPath(String xPath)
xPath
- the XPath for filter nodes this processor operates onpublic XPathExpression getxPathExpression()
public void setxPathExpression(XPathExpression xPathExpression)
xPathExpression
- the xpath expression applied to the filter node that this processor operates onpublic String getDelimiter()
public void setDelimiter(String delimiter)
delimiter
- the delimeter used to separate string tokenspublic String getIdFilterMatch()
public void setIdFilterMatch(String idFilterMatch)
idFilterMatch
- the terms used to identify an 'id' filterpublic String getCatalogQuery()
public void setCatalogQuery(String catalogQuery)
catalogQuery
- the 'catalogQuery' portion of a query filterpublic String getIsPartOfFilterMatch()
public void setIsPartOfFilterMatch(String isPartOfMatch)
isPartOfMatch
- the terms used to identify an 'isPartOf' filterpublic List<LeafElement> getLeafs()
public void setLeafs(List<LeafElement> leafs)
leafs
- the 'leaf' elements defined for a filterpublic List<FilterRootElement> getSubRoots()
public void setSubRoots(List<FilterRootElement> subRoots)
subRoots
- the children filter nodespublic List<FilterProcessor> getFilters()
public void setFilters(List<FilterProcessor> filters)
filters
- all defined filter processorspublic FilterGroupProcessor getFilterGroup()
public void setFilterGroup(FilterGroupProcessor filterGroup)
filterGroup
- defined filter group processorCopyright © 2022. All rights reserved.