Class Filter
- java.lang.Object
-
- uk.gov.gchq.gaffer.operation.impl.function.Filter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Function
,Input<Iterable<? extends Element>>
,InputOutput<Iterable<? extends Element>,Iterable<? extends Element>>
,MultiInput<Element>
,Output<Iterable<? extends Element>>
,Operation
public class Filter extends Object implements Function, InputOutput<Iterable<? extends Element>,Iterable<? extends Element>>, MultiInput<Element>
AFilter
operation appliesElementFilter
(s) to the providedIterable
ofElement
s and returns anIterable
. TheElementFilter
can be applied to a specific group ofEdge
orEntity
, to anyEdge
orEntity
, or simply to anyElement
in theIterable
. For more complex queries, aMap
of groups toElementFilter
s can also be provided to eitherEdge
s orEntity
s.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Filter.Builder
-
Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation
Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>
-
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,ElementFilter>
getEdges()
Map<String,ElementFilter>
getEntities()
ElementFilter
getGlobalEdges()
ElementFilter
getGlobalElements()
ElementFilter
getGlobalEntities()
Iterable<? extends Element>
getInput()
Map<String,String>
getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Element>>
getOutputTypeReference()
void
setEdges(Map<String,ElementFilter> edges)
void
setEntities(Map<String,ElementFilter> entities)
void
setGlobalEdges(ElementFilter globalEdges)
void
setGlobalElements(ElementFilter globalElements)
void
setGlobalEntities(ElementFilter globalEntities)
void
setInput(Iterable<? extends Element> input)
void
setOptions(Map<String,String> options)
Filter
shallowClone()
Operation implementations should ensure a ShallowClone method is implemented.-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.io.MultiInput
createInputArray, setInput
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation
_getNullOrOptions, addOption, containsOption, getOption, getOption, validate, validateRequiredFieldPresent
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output
castToOutputType, getOutputClass, getOutputType
-
-
-
-
Method Detail
-
shallowClone
public Filter shallowClone() throws org.apache.commons.lang3.exception.CloneFailedException
Description copied from interface:Operation
Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.- Specified by:
shallowClone
in interfaceOperation
- Returns:
- shallow clone
- Throws:
org.apache.commons.lang3.exception.CloneFailedException
- if a Clone error occurs
-
getOptions
public Map<String,String> getOptions()
- Specified by:
getOptions
in interfaceOperation
- Returns:
- the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.
-
setOptions
public void setOptions(Map<String,String> options)
- Specified by:
setOptions
in interfaceOperation
- Parameters:
options
- the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.
-
getEdges
public Map<String,ElementFilter> getEdges()
Description copied from interface:Function
-
setEdges
public void setEdges(Map<String,ElementFilter> edges)
-
getEntities
public Map<String,ElementFilter> getEntities()
Description copied from interface:Function
Should return aMap
ofEntity
group to anElement
Function, eg. an ElementFilter This is to enable generic handling of each of the implementations ofFunction
.- Specified by:
getEntities
in interfaceFunction
- Returns:
- A map of Entity group to Element Function
-
setEntities
public void setEntities(Map<String,ElementFilter> entities)
-
getGlobalElements
public ElementFilter getGlobalElements()
-
setGlobalElements
public void setGlobalElements(ElementFilter globalElements)
-
getGlobalEntities
public ElementFilter getGlobalEntities()
-
setGlobalEntities
public void setGlobalEntities(ElementFilter globalEntities)
-
getGlobalEdges
public ElementFilter getGlobalEdges()
-
setGlobalEdges
public void setGlobalEdges(ElementFilter globalEdges)
-
-