LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral Class Reference

action to run graphql query by a literal. More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral:

Public Member Functions

 CQueryLiteral ()
 ctor More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL
final IFuzzyValue< Boolean > execute (final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List< ITerm > p_argument, @Nonnull final List< ITerm > p_return)
 defines a plan-body operation More...
 
final int minimalArgumentNumber ()
 minimum number of arguments More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
final IPath name ()
 returns the name with path of the action More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IBaseAction
final boolean equals (final Object p_object)
 
final int hashCode ()
 
final String toString ()
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IAction
default Stream< IVariable<?> > variables ()
 returns a stream with all used variables More...
 

Protected Member Functions

final String argumentquery ( @Nonnull final ITerm p_argument)
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL
 IBaseGraphQL (final int p_length)
 ctor More...
 
abstract String argumentquery ( @Nonnull final ITerm p_argument)
 convert argument into graphql query More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.IBaseWeb
 IBaseWeb (final int p_length)
 ctor More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
 IBuiltinAction ()
 ctor More...
 
 IBuiltinAction (final int p_length)
 ctor More...
 

Static Private Member Functions

static String fields ( @Nonnull final Stream< ITerm > p_stream)
 creates the field list More...
 
static String root ( @Nonnull final ILiteral p_literal)
 converts a literal query structure More...
 
static String typeformat (final Object p_value)
 type mapping More...
 
static String valueformat ( @Nonnull final ILiteral p_literal)
 format query argument More...
 
static String values ( @Nonnull final Stream< ITerm > p_stream)
 argument values More...
 

Static Private Attributes

static final long serialVersionUID = -6514047475694739845L
 serial id More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.action.IAction
long serialVersionUID = -6374480398439703170L
 serial id More...
 
- Static Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL
static Stream< ITermsendquery ( @Nonnull final String p_url, @Nonnull final String p_query) throws IOException
 executes graphql query and returns a stream of terms of the result More...
 
- Static Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.IBaseWeb
static ITerm baseliteral ( @Nonnull final Stream< String > p_functor, @Nonnull final Stream< ITerm > p_values)
 creates a literal structure from a stream of string elements, the string stream will be build in a tree structure More...
 
static Stream< ITermflatterm ( @Nullable final Object p_object)
 converts an object into a term stream More...
 
static HttpGet httpget ( @Nonnull final String p_url)
 returns a http-get connection More...
 
static String httpgetexecute ( @Nonnull final String p_url) throws IOException
 execute http-get request More...
 
static String httpgetexecute ( @Nonnull final HttpGet p_get) throws IOException
 execute http-get request More...
 
static HttpPost httppost ( @Nonnull final String p_url)
 returns a http-post connection More...
 
static String httppostexecute ( @Nonnull final HttpPost p_post) throws IOException
 execute http-post request More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL
static final ObjectMapper JSONMAPPER = new ObjectMapper()
 json mapper More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
static final Logger LOGGER = CCommon.logger( IBuiltinAction.class )
 logger More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.IBaseAction
static final Logger LOGGER = org.lightjason.agentspeak.common.CCommon.logger( IAction.class )
 logger More...
 

Detailed Description

The calls the data of a graphql service and returns a literal based on the query result, the input argument is at the first position the graphql service url, the second argument a literal, which defines the query structure and all other arguments the literal functor structure. The action fails on connection and parsing errors.

L = generic/type/parseliteral( "allUsers(id, firstName, lastName)" ); GQ = web/graphql/queryliteral( "https://fakerql.com/graphql", L, "graphql-fake" );
See also
http://graphql.org/

Definition at line 48 of file CQueryLiteral.java.

Constructor & Destructor Documentation

◆ CQueryLiteral()

org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.CQueryLiteral ( )

Definition at line 58 of file CQueryLiteral.java.

Member Function Documentation

◆ argumentquery()

final String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.argumentquery ( @Nonnull final ITerm  p_argument)
protected

Definition at line 64 of file CQueryLiteral.java.

References org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.root().

+ Here is the call graph for this function:

◆ fields()

static String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.fields ( @Nonnull final Stream< ITerm p_stream)
staticprivate
Parameters
p_streamfield stream
Returns
string definition

Definition at line 116 of file CQueryLiteral.java.

References org.lightjason.agentspeak.language.ITerm.functor(), org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.root(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.values().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.root().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ root()

static String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.root ( @Nonnull final ILiteral  p_literal)
staticprivate
Parameters
p_literalliteral
Returns
query string

Definition at line 76 of file CQueryLiteral.java.

References org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.fields(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.values().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.argumentquery(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.fields().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ typeformat()

static String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.typeformat ( final Object  p_value)
staticprivate
Parameters
p_valueany value
Returns
graphql string

Definition at line 151 of file CQueryLiteral.java.

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.valueformat().

+ Here is the caller graph for this function:

◆ valueformat()

static String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.valueformat ( @Nonnull final ILiteral  p_literal)
staticprivate
Parameters
p_literalliteral
Returns
functor with value

Definition at line 134 of file CQueryLiteral.java.

References org.lightjason.agentspeak.language.ITerm.raw(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.typeformat().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.values().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ values()

static String org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.values ( @Nonnull final Stream< ITerm p_stream)
staticprivate
Parameters
p_streamterm stream
Returns
string arguemnts

Definition at line 98 of file CQueryLiteral.java.

References org.lightjason.agentspeak.language.ITerm.functor(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.valueformat().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.fields(), and org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.root().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.web.graphql.CQueryLiteral.serialVersionUID = -6514047475694739845L
staticprivate

Definition at line 53 of file CQueryLiteral.java.