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
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.
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	isMandatory() Get whether this attribute must be provided during save.
boolean	isMandatoryForCreate() Get whether this attribute must be provided during parent entity creation.
boolean	isMandatoryForUpdate() Get whether this attribute must be provided during parent entity update.
boolean	isNullable() Get whether this attribute can be null.
boolean	isNullableForCreate() Get whether this attribute can be null at parent entity creation time.
boolean	isNullableForUpdate() Get whether this attribute can be null at parent entity creation time.
boolean	isReadable() Get whether this attribute will be available in schema queries for retrieving this attribute parent entity.
boolean	isSaveable() Get whether this attribute will be available in schema mutations for saving this attribute parent entity.
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	setMandatory(boolean mandatory) Set whether this attribute can be null.
GQLAbstractAttributeMetaData	setMandatoryForCreate(boolean mandatoryForCreate) Set whether this attribute must be provided during parent entity creation.
GQLAbstractAttributeMetaData	setMandatoryForUpdate(boolean mandatoryForUpdate) Set whether this attribute must be provided during parent entity update.
GQLAbstractAttributeMetaData	setName(String name) Set the name for the attribute.
GQLAbstractAttributeMetaData	setNullable(boolean nullable) Set whether this attribute can be null.
GQLAbstractAttributeMetaData	setNullableForCreate(boolean nullableForCreate) Set whether this attribute can be null at parent entity creation time.
GQLAbstractAttributeMetaData	setNullableForUpdate(boolean nullableForUpdate) Set whether this attribute can be null at parent entity creation time.
GQLAbstractAttributeMetaData	setReadable(boolean readable) Set whether this attribute will be available in schema queries for retrieving this attribute parent entity.
GQLAbstractAttributeMetaData	setSaveable(boolean saveable) Set whether this attribute will be available in schema mutations for saving this attribute parent entity.

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

isNullable

public boolean isNullable()

Get whether this attribute can be null. This is a shortcut to (isNullableForCreate() AND isNullableForUpdate())

Returns:

the nullable

setNullable

public GQLAbstractAttributeMetaData setNullable(boolean nullable)

Set whether this attribute can be null. This will set nullableForCreate AND nullableForUpdate to the same given value

Parameters:

nullable - the nullable to set

Returns:

this instance

isMandatory

public boolean isMandatory()

Get whether this attribute must be provided during save. This is a shortcut to (isMandatoryForCreate() AND isMandatoryForUpdate())

Returns:

the mandatory

setMandatory

public GQLAbstractAttributeMetaData setMandatory(boolean mandatory)

Set whether this attribute can be null. This will set mandatoryForCreate AND mandatoryForUpdate to the same given value

Parameters:

mandatory - the mandatory to set

Returns:

this instance

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

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

isReadable

public boolean isReadable()

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

Returns:

the readable

setReadable

public GQLAbstractAttributeMetaData setReadable(boolean readable)

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

Parameters:

readable - the readable to set

Returns:

this instance

isSaveable

public boolean isSaveable()

Get whether this attribute will be available in schema mutations for saving this attribute parent entity. Default is true.

Returns:

the saveable

setSaveable

public GQLAbstractAttributeMetaData setSaveable(boolean saveable)

Set whether this attribute will be available in schema mutations for saving this attribute parent entity. Default is true.

Parameters:

saveable - the saveable to set

Returns:

this instance

isNullableForCreate

public boolean isNullableForCreate()

Get whether this attribute can be null at parent entity creation time. Default is true.

Returns:

the nullableForCreate

setNullableForCreate

public GQLAbstractAttributeMetaData setNullableForCreate(boolean nullableForCreate)

Set whether this attribute can be null at parent entity creation time. Default is true.

Parameters:

nullableForCreate - the nullableForCreate to set

Returns:

this instance

isNullableForUpdate

public boolean isNullableForUpdate()

Get whether this attribute can be null at parent entity creation time. Default is true.

Returns:

the nullableForUpdate

setNullableForUpdate

public GQLAbstractAttributeMetaData setNullableForUpdate(boolean nullableForUpdate)

Set whether this attribute can be null at parent entity creation time. Default is true.

Parameters:

nullableForUpdate - the nullableForUpdate to set

Returns:

this instance

isMandatoryForCreate

public boolean isMandatoryForCreate()

Get whether this attribute must be provided during parent entity creation. This does not mean it cannot be null, this is given by isNullable() or isNullableForCreate() methods. Default is false.

Returns:

the mandatoryForCreate

setMandatoryForCreate

public GQLAbstractAttributeMetaData setMandatoryForCreate(boolean mandatoryForCreate)

Set whether this attribute must be provided during parent entity creation. This does not mean it cannot be null, this is configurable with setNullable(boolean) or setNullableForCreate(boolean) methods. Default is false.

Parameters:

mandatoryForCreate - the mandatoryForCreate to set

Returns:

this instance

isMandatoryForUpdate

public boolean isMandatoryForUpdate()

Get whether this attribute must be provided during parent entity update. This does not mean it cannot be null, this is given by isNullable() or isNullableForUpdate() methods. Default is false.

Returns:

the mandatoryForUpdate

setMandatoryForUpdate

public GQLAbstractAttributeMetaData setMandatoryForUpdate(boolean mandatoryForUpdate)

Set whether this attribute must be provided during parent entity update. This does not mean it cannot be null, this is configurable with setNullable(boolean) or setNullableForUpdate(boolean) methods. Default is false.

Parameters:

mandatoryForUpdate - the mandatoryForUpdate 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