com.kobylynskyi.graphql.codegen.mapper

Interface DataModelMapper

All Known Implementing Classes:

JavaDataModelMapper, KotlinDataModelMapper, ScalaDataModelMapper

public interface DataModelMapper

Method Summary

Modifier and Type	Method and Description
java.lang.String	capitalizeIfRestricted(MappingContext mappingContext, java.lang.String fieldName) Capitalize field name if it is language-restricted.
java.lang.String	capitalizeMethodNameIfRestricted(MappingContext mappingContext, java.lang.String methodName) Capitalize method name if it is language-restricted.
static java.lang.String	getApiClassNameWithPrefixAndSuffix(MappingContext mappingContext, ExtendedFieldDefinition fieldDefinition, java.lang.String rootTypeName, java.util.List<java.lang.String> fieldNames) Generates an api class name including prefix and suffix (if any) Examples: CreateEventMutationResolver, EventsQueryResolver, EventsByIdsQueryResolver (rootTypeName is "Query" or the likes)
static java.lang.String	getApiClassNameWithPrefixAndSuffix(MappingContext mappingContext, ExtendedObjectTypeDefinition definition) Generates an api class name including prefix and suffix (if any) Examples: MutationResolver, QueryResolver, etc
static java.lang.String	getApiPackageName(MappingContext mappingContext) Get java package name for api class.
static java.lang.String	getApiPrefix(MappingContext mappingContext, graphql.language.SourceLocation sourceLocation) Get the prefix for api class name based on the defined strategy and GraphQL node source location.
static java.lang.String	getClassNameSuffixWithInputValues(ExtendedFieldDefinition fieldDefinition) Builds a className suffix based on the input values.
static java.util.Set<java.lang.String>	getImports(MappingContext mappingContext, java.lang.String packageName) Returns imports required for a generated class: - model package name - generic package name
static java.util.List<ExtendedInterfaceTypeDefinition>	getInterfacesOfType(ExtendedImplementingTypeDefinition<?,?> definition, ExtendedDocument document) Scan document and return all interfaces that given type implements.
default java.lang.String	getModelClassNameWithPrefixAndSuffix(MappingContext mappingContext, ExtendedDefinition<?,?> extendedDefinition) Generates a model class name including prefix and suffix (if any)
static java.lang.String	getModelClassNameWithPrefixAndSuffix(MappingContext mappingContext, java.lang.String definitionName) Generates a model class name including prefix and suffix (if any)
static java.lang.String	getModelPackageName(MappingContext mappingContext) Get java package name for model class.
static java.lang.String	getParametrizedInputClassName(MappingContext mappingContext, ExtendedFieldDefinition fieldDefinition, ExtendedDefinition<?,?> parentTypeDefinition) Generates a class name for ParametrizedInput
static java.util.function.Function<java.io.File,java.lang.String>	getParentFileNameFunction()
static java.lang.String	getPrefixFromSourceLocation(graphql.language.SourceLocation sourceLocation, java.util.function.Function<java.io.File,java.lang.String> fileStringFunction) Get the prefix (used as a prefix for class names) from GraphQL source location (file) using the supplied function fileStringFunction.
static java.lang.String	getTypeResolverClassNameWithPrefixAndSuffix(MappingContext mappingContext, java.lang.String typeName) Generates a type resolver class name including prefix and suffix (if any)

Method Detail

getModelClassNameWithPrefixAndSuffix

static java.lang.String getModelClassNameWithPrefixAndSuffix(MappingContext mappingContext,
                                                             java.lang.String definitionName)

Generates a model class name including prefix and suffix (if any)

Parameters:

mappingContext - Global mapping context

definitionName - GraphQL node name

Returns:

Class name of GraphQL model node

getTypeResolverClassNameWithPrefixAndSuffix

static java.lang.String getTypeResolverClassNameWithPrefixAndSuffix(MappingContext mappingContext,
                                                                    java.lang.String typeName)

Generates a type resolver class name including prefix and suffix (if any)

Parameters:

mappingContext - Global mapping context

typeName - GraphQL type name

Returns:

Class name of GraphQL type resolver

getApiClassNameWithPrefixAndSuffix

static java.lang.String getApiClassNameWithPrefixAndSuffix(MappingContext mappingContext,
                                                           ExtendedFieldDefinition fieldDefinition,
                                                           java.lang.String rootTypeName,
                                                           java.util.List<java.lang.String> fieldNames)

Generates an api class name including prefix and suffix (if any) Examples: CreateEventMutationResolver, EventsQueryResolver, EventsByIdsQueryResolver (rootTypeName is "Query" or the likes)

Parameters:

mappingContext - Global mapping context

fieldDefinition - GraphQL field definition

rootTypeName - Object type (e.g.: "Query", "Mutation" or "Subscription")

fieldNames - Names of all fields inside the rootType. Used to detect duplicate

Returns:

Class name of GraphQL api node

getApiClassNameWithPrefixAndSuffix

static java.lang.String getApiClassNameWithPrefixAndSuffix(MappingContext mappingContext,
                                                           ExtendedObjectTypeDefinition definition)

Generates an api class name including prefix and suffix (if any) Examples: MutationResolver, QueryResolver, etc

Parameters:

mappingContext - Global mapping context

definition - GraphQL object definition of a root type like Query

Returns:

Class name of GraphQL api node

getApiPrefix

static java.lang.String getApiPrefix(MappingContext mappingContext,
                                     graphql.language.SourceLocation sourceLocation)

Get the prefix for api class name based on the defined strategy and GraphQL node source location.

Parameters:

mappingContext - Global mapping context

sourceLocation - GraphQL node SourceLocation

Returns:

prefix for the api class

getPrefixFromSourceLocation

static java.lang.String getPrefixFromSourceLocation(graphql.language.SourceLocation sourceLocation,
                                                    java.util.function.Function<java.io.File,java.lang.String> fileStringFunction)

Get the prefix (used as a prefix for class names) from GraphQL source location (file) using the supplied function fileStringFunction. Examples: ("src/test/resources/order-service/schema.graphql", File::getParent) becomes "OrderService" ("src/test/resources/product-service/ProductApis.graphql", File::getName) becomes "ProductApis"

Parameters:

sourceLocation - source location of GraphQL definition

fileStringFunction - function to fetch File's attribute (name, parent, etc)

Returns:

prefix of the file.

getParametrizedInputClassName

static java.lang.String getParametrizedInputClassName(MappingContext mappingContext,
                                                      ExtendedFieldDefinition fieldDefinition,
                                                      ExtendedDefinition<?,?> parentTypeDefinition)

Generates a class name for ParametrizedInput

Parameters:

mappingContext - Global mapping context

fieldDefinition - GraphQL field definition for a field that has parametrized input

parentTypeDefinition - GraphQL definition which is a parent for fieldDefinition

Returns:

Class name of parametrized input

getApiPackageName

static java.lang.String getApiPackageName(MappingContext mappingContext)

Get java package name for api class.

Parameters:

mappingContext - Global mapping context

Returns:

api package name if present. Generic package name otherwise

getModelPackageName

static java.lang.String getModelPackageName(MappingContext mappingContext)

Get java package name for model class.

Parameters:

mappingContext - Global mapping context

Returns:

model package name if present. Generic package name otherwise

getImports

static java.util.Set<java.lang.String> getImports(MappingContext mappingContext,
                                                  java.lang.String packageName)

Returns imports required for a generated class: - model package name - generic package name

Parameters:

mappingContext - Global mapping context

packageName - Package name of the generated class which will be ignored

Returns:

all imports required for a generated class

getClassNameSuffixWithInputValues

static java.lang.String getClassNameSuffixWithInputValues(ExtendedFieldDefinition fieldDefinition)

Builds a className suffix based on the input values. Examples: 1. fieldDefinition has some input values: "ids" becomes "ByIds" "category", "status" becomes "ByCategoryAndStatus"

Parameters:

fieldDefinition - field definition that has some InputValueDefinitions

Returns:

className suffix based on the input values

getInterfacesOfType

static java.util.List<ExtendedInterfaceTypeDefinition> getInterfacesOfType(ExtendedImplementingTypeDefinition<?,?> definition,
                                                                           ExtendedDocument document)

Scan document and return all interfaces that given type implements.

Parameters:

definition - GraphQL definition that might implement some interfaces

document - GraphQL document

Returns:

all interfaces that given type implements.

getParentFileNameFunction

static java.util.function.Function<java.io.File,java.lang.String> getParentFileNameFunction()

capitalizeIfRestricted

java.lang.String capitalizeIfRestricted(MappingContext mappingContext,
                                        java.lang.String fieldName)

Capitalize field name if it is language-restricted. Examples: * 'class' becomes 'Class' * 'int' becomes 'Int'

Parameters:

fieldName - any string

mappingContext - Global mapping context

Returns:

capitalized value if it is restricted in java/scala/kotlin/etc, same value as parameter otherwise

capitalizeMethodNameIfRestricted

java.lang.String capitalizeMethodNameIfRestricted(MappingContext mappingContext,
                                                  java.lang.String methodName)

Capitalize method name if it is language-restricted. Examples: * 'getClass' becomes 'GetClass' * 'wait' becomes 'Wait' * 'this' becomes 'This'

Parameters:

methodName - any string

mappingContext - Global mapping context

Returns:

capitalized value if it is restricted in java/scala/kotlin/etc, same value as parameter otherwise

getModelClassNameWithPrefixAndSuffix

default java.lang.String getModelClassNameWithPrefixAndSuffix(MappingContext mappingContext,
                                                              ExtendedDefinition<?,?> extendedDefinition)

Generates a model class name including prefix and suffix (if any)

Parameters:

mappingContext - Global mapping context, record enum type

extendedDefinition - GraphQL extended definition

Returns:

Class name of GraphQL model node