Package uk.gov.gchq.gaffer.federatedstore.operation

Class AddGraph

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.operation.AddGraph

All Implemented Interfaces:

Closeable, AutoCloseable, IFederationOperation, Operation

Direct Known Subclasses:

AddGraphWithHooks

public class AddGraph
extends Object
implements IFederationOperation

An Operation used for adding graphs to a FederatedStore.

Requires:

• graphId
• storeProperties and/or parentPropertiesId
• schema and/or parentSchemaIds

parentId can be used solely, if known by the graphLibrary.

schema can be used solely.

storeProperties can be used, if authorised to by FederatedStore.isLimitedToLibraryProperties(uk.gov.gchq.gaffer.user.User) both non-parentId and parentId can be used, and will be merged together.

See Also:

FederatedStore, Schema, Properties, Graph

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddGraph.AddGraphBuilder<OP extends AddGraph,B extends AddGraph.AddGraphBuilder<OP,?>>
static class	AddGraph.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.federatedstore.operation.IFederationOperation

IFederationOperation.BaseBuilder<OP extends IFederationOperation,B extends Operation.BaseBuilder<OP,?>>

Constructor Summary

Constructors

Constructor	Description
AddGraph()

Method Summary

Modifier and Type	Method	Description
Set<String>	getGraphAuths()
String	getGraphId()
boolean	getIsPublic()
Map<String,String>	getOptions()
String	getParentPropertiesId()
List<String>	getParentSchemaIds()
Properties	getProperties()
AccessPredicate	getReadAccessPredicate()
Schema	getSchema()
StoreProperties	getStoreProperties()
AccessPredicate	getWriteAccessPredicate()
boolean	isUserRequestingAdminUsage()
void	setGraphAuths(Set<String> graphAuths)
void	setGraphId(String graphId)
void	setIsPublic(boolean isPublic)
void	setOptions(Map<String,String> options)
void	setParentPropertiesId(String parentPropertiesId)
void	setParentSchemaIds(List<String> parentSchemaIds)
void	setProperties(Properties properties)
void	setReadAccessPredicate(AccessPredicate readAccessPredicate)
void	setSchema(Schema schema)
void	setStoreProperties(StoreProperties properties)
AddGraph	setUserRequestingAdminUsage(boolean adminRequest)
void	setWriteAccessPredicate(AccessPredicate writeAccessPredicate)
AddGraph	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.Operation

_getNullOrOptions, addOption, close, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Constructor Detail

AddGraph

public AddGraph()

Method Detail

getGraphId

public String getGraphId()

setGraphId

public void setGraphId(String graphId)

getSchema

public Schema getSchema()

setSchema

public void setSchema(Schema schema)

shallowClone

public AddGraph 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 interface Operation

Returns:

shallow clone

Throws:

org.apache.commons.lang3.exception.CloneFailedException - if a Clone error occurs

getParentSchemaIds

public List<String> getParentSchemaIds()

setParentSchemaIds

public void setParentSchemaIds(List<String> parentSchemaIds)

getStoreProperties

public StoreProperties getStoreProperties()

setStoreProperties

public void setStoreProperties(StoreProperties properties)

getParentPropertiesId

public String getParentPropertiesId()

setParentPropertiesId

public void setParentPropertiesId(String parentPropertiesId)

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

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 interface Operation

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.

getGraphAuths

public Set<String> getGraphAuths()

setGraphAuths

public void setGraphAuths(Set<String> graphAuths)

getProperties

public Properties getProperties()

setProperties

public void setProperties(Properties properties)

setIsPublic

public void setIsPublic(boolean isPublic)

getIsPublic

public boolean getIsPublic()

getWriteAccessPredicate

public AccessPredicate getWriteAccessPredicate()

setWriteAccessPredicate

public void setWriteAccessPredicate(AccessPredicate writeAccessPredicate)

getReadAccessPredicate

public AccessPredicate getReadAccessPredicate()

setReadAccessPredicate

public void setReadAccessPredicate(AccessPredicate readAccessPredicate)

isUserRequestingAdminUsage

public boolean isUserRequestingAdminUsage()

Specified by:

isUserRequestingAdminUsage in interface IFederationOperation

setUserRequestingAdminUsage

public AddGraph setUserRequestingAdminUsage(boolean adminRequest)

Specified by:

setUserRequestingAdminUsage in interface IFederationOperation