Class Filtered
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.mongodbfinddocuments.AbstractMongoDbFindDocuments
-
- adams.flow.transformer.mongodbfinddocuments.Filtered
-
- All Implemented Interfaces:
adams.core.Destroyable
,adams.core.GlobalInfoSupporter
,adams.core.logging.LoggingLevelHandler
,adams.core.logging.LoggingSupporter
,adams.core.option.OptionHandler
,adams.core.QuickInfoSupporter
,adams.core.SizeOfHandler
,adams.flow.core.FlowContextHandler
,MongoDbFindDocuments
,Serializable
public class Filtered extends AbstractMongoDbFindDocuments
Returns all documents in the collection that match the filter.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected MongoDbDocumentFilter
m_Filter
the filter to use.-
Fields inherited from class adams.flow.transformer.mongodbfinddocuments.AbstractMongoDbFindDocuments
m_FlowContext
-
-
Constructor Summary
Constructors Constructor Description Filtered()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected com.mongodb.client.FindIterable<org.bson.Document>
doFind(com.mongodb.client.MongoCollection coll)
Filters the collection.String
filterTipText()
Returns the tip text for this property.MongoDbDocumentFilter
getFilter()
Returns the filter to apply.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.String
globalInfo()
Returns a string describing the object.void
setFilter(MongoDbDocumentFilter value)
Sets the filter to apply.-
Methods inherited from class adams.flow.transformer.mongodbfinddocuments.AbstractMongoDbFindDocuments
check, find, getFlowContext, setFlowContext
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
-
-
-
Field Detail
-
m_Filter
protected MongoDbDocumentFilter m_Filter
the filter to use.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.core.option.AbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classadams.core.option.AbstractOptionHandler
-
setFilter
public void setFilter(MongoDbDocumentFilter value)
Sets the filter to apply.- Parameters:
value
- the filter
-
getFilter
public MongoDbDocumentFilter getFilter()
Returns the filter to apply.- Returns:
- the filter
-
filterTipText
public String filterTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractMongoDbFindDocuments
- Returns:
- null if no info available, otherwise short string
-
doFind
protected com.mongodb.client.FindIterable<org.bson.Document> doFind(com.mongodb.client.MongoCollection coll)
Filters the collection.- Specified by:
doFind
in classAbstractMongoDbFindDocuments
- Parameters:
coll
- the collection to filter- Returns:
- the documents matching the query
-
-