Package uk.gov.gchq.gaffer.data.elementdefinition.view

Class NamedViewDetail

java.lang.Object

uk.gov.gchq.gaffer.data.elementdefinition.view.NamedViewDetail

All Implemented Interfaces:

Serializable, AccessControlledResource

public class NamedViewDetail
extends Object
implements AccessControlledResource, Serializable

Simple POJO containing the details associated with a NamedView.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedViewDetail.Builder

Field Summary

Fields inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

DONT_CHECK_ADMIN_AUTH

Constructor Summary

Constructors

Constructor	Description
NamedViewDetail()
NamedViewDetail(String name, String view, String description, String userId, List<String> writers, Map<String,ViewParameterDetail> parameters)
NamedViewDetail(String name, String view, String description, String userId, List<String> writers, Map<String,ViewParameterDetail> parameters, AccessPredicate readAccessPredicate, AccessPredicate writeAccessPredicate)
NamedViewDetail(String name, String view, String description, Map<String,ViewParameterDetail> parameters)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCreatorId()
String	getDescription()
String	getName()
AccessPredicate	getOrDefaultReadAccessPredicate()
AccessPredicate	getOrDefaultWriteAccessPredicate()
Map<String,ViewParameterDetail>	getParameters()
AccessPredicate	getReadAccessPredicate()
ResourceType	getResourceType()
String	getView()
View	getView(Map<String,Object> executionParams)	Gets the View after adding in the parameters specified.
View	getViewWithDefaultParams()	Gets the View after adding in default values for any parameters.
AccessPredicate	getWriteAccessPredicate()
List<String>	getWriteAccessRoles()
int	hashCode()
boolean	hasReadAccess(User user, String adminAuth)
boolean	hasWriteAccess(User user, String adminAuth)
void	setDescription(String description)
void	setName(String name)
void	setParameters(Map<String,ViewParameterDetail> parameters)
void	setView(String view)
void	setView(View view)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.gov.gchq.gaffer.access.AccessControlledResource

hasReadAccess, hasWriteAccess

Constructor Detail

NamedViewDetail

public NamedViewDetail()

NamedViewDetail

public NamedViewDetail(String name,
                       String view,
                       String description,
                       Map<String,ViewParameterDetail> parameters)

NamedViewDetail

public NamedViewDetail(String name,
                       String view,
                       String description,
                       String userId,
                       List<String> writers,
                       Map<String,ViewParameterDetail> parameters)

NamedViewDetail

public NamedViewDetail(String name,
                       String view,
                       String description,
                       String userId,
                       List<String> writers,
                       Map<String,ViewParameterDetail> parameters,
                       AccessPredicate readAccessPredicate,
                       AccessPredicate writeAccessPredicate)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getView

public String getView()

setView

public void setView(String view)

setView

public void setView(View view)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getCreatorId

public String getCreatorId()

getWriteAccessRoles

public List<String> getWriteAccessRoles()

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in interface AccessControlledResource

hasReadAccess

public boolean hasReadAccess(User user,
                             String adminAuth)

Specified by:

hasReadAccess in interface AccessControlledResource

hasWriteAccess

public boolean hasWriteAccess(User user,
                              String adminAuth)

Specified by:

hasWriteAccess in interface AccessControlledResource

getParameters

public Map<String,ViewParameterDetail> getParameters()

setParameters

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

getViewWithDefaultParams

public View getViewWithDefaultParams()

Gets the View after adding in default values for any parameters. If a parameter does not have a default, null is inserted.

Returns:

The View

Throws:

IllegalArgumentException - if substituting the parameters fails

getView

public View getView(Map<String,Object> executionParams)

Gets the View after adding in the parameters specified. If a parameter does not have a default and none is set an Exception will be thrown.

Parameters:

executionParams - Parameters to add

Returns:

the View with substituted parameters

Throws:

IllegalArgumentException - if substituting the parameters fails

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getReadAccessPredicate

public AccessPredicate getReadAccessPredicate()

getWriteAccessPredicate

public AccessPredicate getWriteAccessPredicate()

getOrDefaultReadAccessPredicate

public AccessPredicate getOrDefaultReadAccessPredicate()

getOrDefaultWriteAccessPredicate

public AccessPredicate getOrDefaultWriteAccessPredicate()