com.daikit.graphql.meta.attribute

Class GQLAbstractAttributeMetaData

java.lang.Object

com.daikit.graphql.meta.GQLAbstractMetaData

com.daikit.graphql.meta.attribute.GQLAbstractAttributeMetaData

Direct Known Subclasses:

GQLAttributeEntityMetaData, GQLAttributeEnumMetaData, GQLAttributeListEntityMetaData, GQLAttributeListEnumMetaData, GQLAttributeListScalarMetaData, GQLAttributeScalarMetaData

public abstract class GQLAbstractAttributeMetaData
extends GQLAbstractMetaData

Abstract super class for GraphQL entity/data attribute meta data

Author:

Thibaut Caselli

Constructor Summary

Constructors

Constructor and Description
GQLAbstractAttributeMetaData() Default constructor
GQLAbstractAttributeMetaData(String name) Constructor passing name and keeping default values for other attributes.

Method Summary

Modifier and Type	Method and Description
GQLAbstractAttributeMetaData	addRights(GQLAttributeRightsMetaData... rightsArray) Add given rights
protected void	appendToString(StringBuilder stringBuilder)
String	getDescription() Get the description for the attribute.
IGQLDynamicAttributeGetter<?,?>	getDynamicAttributeGetter() If this attribute is dynamic then this method returns the getter for computing the attribute value.
IGQLDynamicAttributeSetter<?,?>	getDynamicAttributeSetter() If this attribute is dynamic then this method returns the setter for storing the attribute value.
String	getName() Get the name for the attribute.
List<GQLAttributeRightsMetaData>	getRights()
boolean	isDynamic() Get whether this attribute is dynamic, which means that either a dynamicAttributeGetter or a dynamicAttributeSetter (or both) is/are set.
boolean	isDynamicAttributeGetter() Get whether this attribute is a dynamic attribute getter, which means that a dynamicAttributeGetter is set
boolean	isDynamicAttributeSetter() Get whether this attribute is a dynamic attribute setter, which means that a dynamicAttributeSetter is set
boolean	isFilterable() Get whether this attribute will be available in schema queries filters for retrieving this attribute parent entity.
boolean	isMandatoryForCreate(GQLExecutionContext executionContext) Get whether this attribute is mandatory for creation in given context
boolean	isMandatoryForUpdate(GQLExecutionContext executionContext) Get whether this attribute is mandatory for update in given context
boolean	isNullableForCreate(GQLExecutionContext executionContext) Get whether this attribute is nullable for creation in given context
boolean	isNullableForUpdate(GQLExecutionContext executionContext) Get whether this attribute is nullable for update in given context
boolean	isReadable(GQLExecutionContext executionContext) Get whether this attribute is readable in given context
boolean	isSaveable(GQLExecutionContext executionContext) Get whether this attribute is saveable in given context
GQLAbstractAttributeMetaData	setDescription(String description) Set the description for the attribute.
GQLAbstractAttributeMetaData	setDynamicAttributeGetter(IGQLDynamicAttributeGetter<?,?> dynamicAttributeGetter) If this attribute is dynamic then this method sets the getter for computing the attribute value.
GQLAbstractAttributeMetaData	setDynamicAttributeSetter(IGQLDynamicAttributeSetter<?,?> dynamicAttributeSetter) If this attribute is dynamic then this method sets the setter for storing the attribute value.
GQLAbstractAttributeMetaData	setFilterable(boolean filterable) Set whether this attribute will be available in schema queries filters for retrieving this attribute parent entity.
GQLAbstractAttributeMetaData	setName(String name) Set the name for the attribute.
void	setRights(List<GQLAttributeRightsMetaData> rights)

Methods inherited from class com.daikit.graphql.meta.GQLAbstractMetaData

finalizeToString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GQLAbstractAttributeMetaData

public GQLAbstractAttributeMetaData()

Default constructor

GQLAbstractAttributeMetaData

public GQLAbstractAttributeMetaData(String name)

Constructor passing name and keeping default values for other attributes.

Parameters:

name - the name for the attribute. This name will be used for building GraphQL schema : queries, mutations, descriptions etc.

Method Detail

appendToString

protected void appendToString(StringBuilder stringBuilder)

Overrides:

appendToString in class GQLAbstractMetaData

isSaveable

public boolean isSaveable(GQLExecutionContext executionContext)

Get whether this attribute is saveable in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isReadable

public boolean isReadable(GQLExecutionContext executionContext)

Get whether this attribute is readable in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isNullableForCreate

public boolean isNullableForCreate(GQLExecutionContext executionContext)

Get whether this attribute is nullable for creation in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isNullableForUpdate

public boolean isNullableForUpdate(GQLExecutionContext executionContext)

Get whether this attribute is nullable for update in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isMandatoryForCreate

public boolean isMandatoryForCreate(GQLExecutionContext executionContext)

Get whether this attribute is mandatory for creation in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isMandatoryForUpdate

public boolean isMandatoryForUpdate(GQLExecutionContext executionContext)

Get whether this attribute is mandatory for update in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isDynamic

public boolean isDynamic()

Get whether this attribute is dynamic, which means that either a dynamicAttributeGetter or a dynamicAttributeSetter (or both) is/are set.

Returns:

a boolean

isDynamicAttributeSetter

public boolean isDynamicAttributeSetter()

Get whether this attribute is a dynamic attribute setter, which means that a dynamicAttributeSetter is set

Returns:

a boolean

isDynamicAttributeGetter

public boolean isDynamicAttributeGetter()

Get whether this attribute is a dynamic attribute getter, which means that a dynamicAttributeGetter is set

Returns:

a boolean

addRights

public GQLAbstractAttributeMetaData addRights(GQLAttributeRightsMetaData... rightsArray)

Add given rights

Parameters:

rightsArray - the array of GQLAttributeRightsMetaData to be added

Returns:

this

getRights

public List<GQLAttributeRightsMetaData> getRights()

Returns:

the rights

setRights

public void setRights(List<GQLAttributeRightsMetaData> rights)

Parameters:

rights - the rights to set

getDescription

public String getDescription()

Get the description for the attribute. This description will be used for building descriptions in GraphQL schema every time this attribute is used in queries, mutations etc.

Returns:

the description

setDescription

public GQLAbstractAttributeMetaData setDescription(String description)

Set the description for the attribute. This description will be used for building descriptions in GraphQL schema every time this attribute is used in queries, mutations etc.

Parameters:

description - the description to set

Returns:

this instance

getName

public String getName()

Get the name for the attribute. This name will be used for building GraphQL schema : queries, mutations, descriptions etc.

Returns:

the name

setName

public GQLAbstractAttributeMetaData setName(String name)

Set the name for the attribute. This name will be used for building GraphQL schema : queries, mutations, descriptions etc.

Parameters:

name - the name to set

Returns:

this instance

isFilterable

public boolean isFilterable()

Get whether this attribute will be available in schema queries filters for retrieving this attribute parent entity. Default is true.

Returns:

the filterable

setFilterable

public GQLAbstractAttributeMetaData setFilterable(boolean filterable)

Set whether this attribute will be available in schema queries filters for retrieving this attribute parent entity. Default is

Parameters:

filterable - the filterable to set

Returns:

this instance

getDynamicAttributeGetter

public IGQLDynamicAttributeGetter<?,?> getDynamicAttributeGetter()

If this attribute is dynamic then this method returns the getter for computing the attribute value. (An attribute is dynamic if there is no related property in holding entity, if you provide a IGQLDynamicAttributeGetter then if this attribute is set in schema queries for retrieving this attribute parent entity then this getter will be called with this attribute value as parameter.)

Returns:

the dynamicAttributeGetter

setDynamicAttributeGetter

public GQLAbstractAttributeMetaData setDynamicAttributeGetter(IGQLDynamicAttributeGetter<?,?> dynamicAttributeGetter)

If this attribute is dynamic then this method sets the getter for computing the attribute value. (An attribute is dynamic if there is no related property in holding entity, if you provide a IGQLDynamicAttributeGetter then if this attribute is set in schema queries for retrieving this attribute parent entity then this getter will be called with this attribute value as parameter.)

Parameters:

dynamicAttributeGetter - the dynamicAttributeGetter to set

Returns:

this instance

getDynamicAttributeSetter

public IGQLDynamicAttributeSetter<?,?> getDynamicAttributeSetter()

If this attribute is dynamic then this method returns the setter for storing the attribute value. (An attribute is dynamic if there is no related property in holding entity, if you provide a IGQLDynamicAttributeSetter then if this attribute is set in schema mutations for saving this attribute parent entity then this setter will be called with this attribute value as parameter.)

Returns:

the dynamicAttributeSetter

setDynamicAttributeSetter

public GQLAbstractAttributeMetaData setDynamicAttributeSetter(IGQLDynamicAttributeSetter<?,?> dynamicAttributeSetter)

If this attribute is dynamic then this method sets the setter for storing the attribute value. (An attribute is dynamic if there is no related property in holding entity, if you provide a IGQLDynamicAttributeSetter then if this attribute is set in schema mutations for saving this attribute parent entity then this setter will be called with this attribute value as parameter.)

Parameters:

dynamicAttributeSetter - the dynamicAttributeSetter to set

Returns:

this instance