com.daikit.graphql.meta.entity

Class GQLEntityMetaData

java.lang.Object

com.daikit.graphql.meta.GQLAbstractMetaData

com.daikit.graphql.meta.entity.GQLEntityMetaData

public class GQLEntityMetaData
extends GQLAbstractMetaData

Abstract super class for all entity meta datas (concrete, abstract, embedded and abstract embedded)

Author:

Thibaut Caselli

Constructor Summary

Constructors

Constructor and Description
GQLEntityMetaData() Default constructor
GQLEntityMetaData(String name, Class<?> entityClass) Constructor passing name and entity class.
GQLEntityMetaData(String name, Class<?> entityClass, boolean concrete) Constructor passing name and entity class.
GQLEntityMetaData(String name, Class<?> entityClass, Class<?> superEntityClass) Constructor passing name, entity class and super entity class and keeping default values for other attributes.
GQLEntityMetaData(String name, Class<?> entityClass, Class<?> superEntityClass, boolean concrete) Constructor passing name, entity class and super entity class and keeping default values for other attributes.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(GQLAbstractAttributeMetaData attribute) Add given attribute if non null
GQLEntityMetaData	addRights(GQLEntityRightsMetaData... rightsArray) Add given rights
protected void	appendToString(StringBuilder stringBuilder)
List<GQLAbstractAttributeMetaData>	getAttributes() Get attributes of the entity
String	getDescription() Get the description for the entity.
Class<?>	getEntityClass() Get the entity class.
String	getName() Set the name for the entity.
List<GQLEntityRightsMetaData>	getRights()
Class<?>	getSuperEntityClass() Get the super class for the entity.
boolean	isConcrete() Get whether the entity is a concrete class (true) or abstract class (false).
boolean	isDeletable(GQLExecutionContext executionContext) Get whether this entity is deleteable in given context
boolean	isEmbedded()
boolean	isReadable(GQLExecutionContext executionContext) Get whether this entity is readable in given context
boolean	isSaveable(GQLExecutionContext executionContext) Get whether this entity is saveable in given context
GQLEntityMetaData	setAttributes(List<GQLAbstractAttributeMetaData> attributes) Set the entity attributes
GQLEntityMetaData	setConcrete(boolean concrete) Set whether the entity is a concrete class (true) or abstract class (false).
GQLEntityMetaData	setDescription(String description) Set the description for the entity.
GQLEntityMetaData	setEmbedded(boolean embedded)
GQLEntityMetaData	setEntityClass(Class<?> entityClass) Set the entity class
GQLEntityMetaData	setName(String name) Get the name for the entity.
void	setRights(List<GQLEntityRightsMetaData> rights)
GQLEntityMetaData	setSuperEntityClass(Class<?> superEntityClass) Set the super class for the 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

GQLEntityMetaData

public GQLEntityMetaData()

Default constructor

GQLEntityMetaData

public GQLEntityMetaData(String name,
                         Class<?> entityClass)

Constructor passing name and entity class. If the entity is abstract then don't forget to set concrete to false.

Parameters:

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

entityClass - the entity class

GQLEntityMetaData

public GQLEntityMetaData(String name,
                         Class<?> entityClass,
                         boolean concrete)

Constructor passing name and entity class.

Parameters:

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

entityClass - the entity class

concrete - whether the entity is a concrete class (true) or abstract class (false). Default is true.

GQLEntityMetaData

public GQLEntityMetaData(String name,
                         Class<?> entityClass,
                         Class<?> superEntityClass)

Constructor passing name, entity class and super entity class and keeping default values for other attributes. If the entity is abstract then don't forget to set concrete to false.

Parameters:

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

entityClass - the entity class

superEntityClass - the super entity class

GQLEntityMetaData

public GQLEntityMetaData(String name,
                         Class<?> entityClass,
                         Class<?> superEntityClass,
                         boolean concrete)

Constructor passing name, entity class and super entity class 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.

entityClass - the entity class

superEntityClass - the super entity class

concrete - whether the entity is a concrete class (true) or abstract class (false). Default is true.

Method Detail

appendToString

protected void appendToString(StringBuilder stringBuilder)

Overrides:

appendToString in class GQLAbstractMetaData

addAttribute

public void addAttribute(GQLAbstractAttributeMetaData attribute)

Add given attribute if non null

Parameters:

attribute - the GQLAbstractAttributeMetaData to be added

isSaveable

public boolean isSaveable(GQLExecutionContext executionContext)

Get whether this entity is saveable in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isReadable

public boolean isReadable(GQLExecutionContext executionContext)

Get whether this entity is readable in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

isDeletable

public boolean isDeletable(GQLExecutionContext executionContext)

Get whether this entity is deleteable in given context

Parameters:

executionContext - the GQLExecutionContext

Returns:

a boolean

addRights

public GQLEntityMetaData addRights(GQLEntityRightsMetaData... rightsArray)

Add given rights

Parameters:

rightsArray - the array of GQLEntityRightsMetaData to be added

Returns:

this

getRights

public List<GQLEntityRightsMetaData> getRights()

Returns:

the rights

setRights

public void setRights(List<GQLEntityRightsMetaData> rights)

Parameters:

rights - the rights to set

getDescription

public String getDescription()

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

Returns:

the description

setDescription

public GQLEntityMetaData setDescription(String description)

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

Parameters:

description - the description to set

Returns:

this instance

isConcrete

public boolean isConcrete()

Get whether the entity is a concrete class (true) or abstract class (false). Default is true.

Returns:

the concrete

setConcrete

public GQLEntityMetaData setConcrete(boolean concrete)

Set whether the entity is a concrete class (true) or abstract class (false). Default is true.

Parameters:

concrete - the concrete to set

Returns:

this instance

getName

public String getName()

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

Returns:

the name

setName

public GQLEntityMetaData setName(String name)

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

Parameters:

name - the name to set

Returns:

this instance

getSuperEntityClass

public Class<?> getSuperEntityClass()

Get the super class for the entity.

Returns:

the superEntityClass

setSuperEntityClass

public GQLEntityMetaData setSuperEntityClass(Class<?> superEntityClass)

Set the super class for the entity. You shouldn't set this property if super class is Object.

Parameters:

superEntityClass - the superEntityClass to set

Returns:

this instance

getEntityClass

public Class<?> getEntityClass()

Get the entity class.

Returns:

the entityClass

setEntityClass

public GQLEntityMetaData setEntityClass(Class<?> entityClass)

Set the entity class

Parameters:

entityClass - the entityClass to set

Returns:

this instance

getAttributes

public List<GQLAbstractAttributeMetaData> getAttributes()

Get attributes of the entity

Returns:

the attributes

setAttributes

public GQLEntityMetaData setAttributes(List<GQLAbstractAttributeMetaData> attributes)

Set the entity attributes

Parameters:

attributes - the attributes to set

Returns:

this instance

isEmbedded

public boolean isEmbedded()

Returns:

the embedded

setEmbedded

public GQLEntityMetaData setEmbedded(boolean embedded)

Parameters:

embedded - the embedded to set

Returns:

this instance