NamedView (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

java.lang.Object
- uk.gov.gchq.gaffer.data.elementdefinition.ElementDefinitions<ViewElementDefinition,ViewElementDefinition>
- - uk.gov.gchq.gaffer.data.elementdefinition.view.View
  - - uk.gov.gchq.gaffer.data.elementdefinition.view.NamedView

All Implemented Interfaces:

Cloneable
```
public class NamedView
extends View
```
A NamedView extends a View, defining the Elements to be returned for an operation. On top of the @{link View}, it contains a name for the View that is defined. It also holds a list of NamedView names, containing all the names of NamedView's that have been merged to define the NamedView.

See Also:

NamedView.Builder, View

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NamedView.BaseBuilder<CHILD_CLASS extends NamedView.BaseBuilder<?>>

static class NamedView.Builder

Constructor Summary

Constructors
Constructor Description

NamedView()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canMerge(View addingView, View srcView)`
`void`	`expandGlobalDefinitions()`	Copies all the global element definitions into the individual element definitions.
`List<String>`	`getMergedNamedViewNames()`
`String`	`getName()`
`Map<String,Object>`	`getParameters()`
`void`	`setMergedNamedViewNames(List<String> mergedNamedViewNames)`
`void`	`setName(String viewName)`
`void`	`setParameters(Map<String,Object> parameters)`

Methods inherited from class uk.gov.gchq.gaffer.data.elementdefinition.view.View
addConfig, clone, equals, fromJson, fromJson, fromJson, getClassName, getConfig, getConfig, getElement, getElementGroupBy, getGlobalEdges, getGlobalElements, getGlobalEntities, hasEdgeFilters, hasEntityFilters, hashCode, hasPostAggregationFilters, hasPostTransformFilters, hasPreAggregationFilters, hasTransform, isAllEdges, isAllEntities, setAllEdges, setAllEntities, toCompactJson, toString

Methods inherited from class uk.gov.gchq.gaffer.data.elementdefinition.ElementDefinitions
getEdge, getEdgeGroups, getEdges, getEntities, getEntity, getEntityGroups, getGroups, hasEdges, hasEntities, hasGroups, isEdge, isEntity, toJson

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- NamedView
```
public NamedView()
```

Method Detail

setName

public void setName(String viewName)

getName
```
public String getName()
```

setMergedNamedViewNames

public void setMergedNamedViewNames(List<String> mergedNamedViewNames)

getMergedNamedViewNames

public List<String> getMergedNamedViewNames()

setParameters

public void setParameters(Map<String,Object> parameters)

getParameters

public Map<String,Object> getParameters()

canMerge

public boolean canMerge(View addingView,
                        View srcView)

Overrides:: canMerge in class View

expandGlobalDefinitions
```
public void expandGlobalDefinitions()
```
Description copied from class: View

Copies all the global element definitions into the individual element definitions. The global element definitions will then be set to null

Overrides:

expandGlobalDefinitions in class View