LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.beliefbase.view.CView Class Reference

view of a beliefbase More...

+ Inheritance diagram for org.lightjason.agentspeak.beliefbase.view.CView:
+ Collaboration diagram for org.lightjason.agentspeak.beliefbase.view.CView:

Public Member Functions

 CView ( @Nonnull final String p_name, @Nonnull final IBeliefbase p_beliefbase)
 ctor More...
 
 CView ( @Nonnull final String p_name, @Nonnull final IBeliefbase p_beliefbase, final IView p_parent)
 ctor More...
 
final IView add ( @Nonnull final Stream< ILiteral > p_literal)
 adds a literal in the current structure More...
 
final IView add ( @Nonnull final ILiteral... p_literal)
 adds a literal in the current structure More...
 
final IView add ( @Nonnull final IView... p_view)
 adds view in the current structure More...
 
final IBeliefbase beliefbase ()
 returns the beliefbase More...
 
final IView clear ( @Nullable final IPath... p_path)
 clears all elements More...
 
final boolean containsLiteral ( @Nonnull final IPath p_path)
 checks if a literal exists More...
 
final boolean containsView ( @Nonnull final IPath p_path)
 view existing check More...
 
final boolean empty ()
 checks if the structure empty More...
 
final boolean equals (final Object p_object)
 
final IView generate ( @Nonnull final IViewGenerator p_generator, @Nonnull final IPath... p_paths)
 generates path structure More...
 
final int hashCode ()
 
final boolean hasParent ()
 check if the view has got a parent More...
 
final String name ()
 returns only the element name More...
 
final IView parent ()
 returns the parent of the view More...
 
final IPath path ()
 returns the full path More...
 
final IView remove ( @Nonnull final IView... p_view)
 removes a view in the current structure More...
 
final IView remove ( @Nonnull final Stream< ILiteral > p_literal)
 removes a literal in the current structure More...
 
final IView remove ( @Nonnull final ILiteral... p_literal)
 removes a literal in the current structure More...
 
final Stream< IViewroot ()
 returns a stream to the root node, More...
 
final int size ()
 returns the size of literals More...
 
final Stream< ILiteralstream ( @Nullable final IPath... p_path)
 returns stream of literal More...
 
final Stream< ILiteralstream (final boolean p_negated, @Nullable final IPath... p_path)
 returns stream of literal More...
 
final String toString ()
 
final Stream< ITriggertrigger ()
 retruns all trigger of the beliefbase More...
 
final IAgent<?> update ( @Nonnull final IAgent<?> p_agent)
 updates all items More...
 
final Stream< IViewwalk ( @Nonnull final IPath p_path, @Nullable final IViewGenerator... p_generator)
 streams path walking More...
 

Private Member Functions

IView leafview ( @Nonnull final Stream< IView > p_stream)
 returns the leaf of a view path More...
 
Stream< IViewwalkdown ( @Nonnull final IPath p_path, @Nullable final IViewGenerator... p_generator)
 inner walking structure of views More...
 

Private Attributes

final IBeliefbase m_beliefbase
 reference to the beliefbase context More...
 
final String m_name
 view name More...
 
final IView m_parent
 parent name More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.beliefbase.view.IView
IView EMPTY
 empty view More...
 

Detailed Description

Template Parameters
Tagent type

Definition at line 48 of file CView.java.

Constructor & Destructor Documentation

◆ CView() [1/2]

org.lightjason.agentspeak.beliefbase.view.CView.CView ( @Nonnull final String  p_name,
@Nonnull final IBeliefbase  p_beliefbase 
)
Parameters
p_nameview name
p_beliefbasereference to the beliefbase context

Definition at line 71 of file CView.java.

◆ CView() [2/2]

org.lightjason.agentspeak.beliefbase.view.CView.CView ( @Nonnull final String  p_name,
@Nonnull final IBeliefbase  p_beliefbase,
final IView  p_parent 
)
Parameters
p_nameview name
p_beliefbasereference to the beliefbase context
p_parentreference to the parent view

Definition at line 84 of file CView.java.

References org.lightjason.agentspeak.common.CCommon.languagestring().

+ Here is the call graph for this function:

Member Function Documentation

◆ add() [1/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.add ( @Nonnull final Stream< ILiteral p_literal)
Parameters
p_literalliteral stream
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 123 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IBeliefbase.add(), org.lightjason.agentspeak.beliefbase.view.IView.beliefbase(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), and org.lightjason.agentspeak.beliefbase.view.CView.walk().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.add().

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

◆ add() [2/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.add ( @Nonnull final ILiteral...  p_literal)
Parameters
p_literalliteral
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 132 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.add().

+ Here is the call graph for this function:

◆ add() [3/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.add ( @Nonnull final IView...  p_view)

◆ beliefbase()

final IBeliefbase org.lightjason.agentspeak.beliefbase.view.CView.beliefbase ( )
Returns
beliefbase

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 332 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.add().

+ Here is the caller graph for this function:

◆ clear()

final IView org.lightjason.agentspeak.beliefbase.view.CView.clear ( @Nullable final IPath...  p_path)
Parameters
p_pathpath values
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 185 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IBeliefbase.clear(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.view.CView.walk().

+ Here is the call graph for this function:

◆ containsLiteral()

final boolean org.lightjason.agentspeak.beliefbase.view.CView.containsLiteral ( @Nonnull final IPath  p_path)
Parameters
p_pathpath to a literal (suffix is literal name)
Returns
existance boolean

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 208 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IBeliefbase.containsLiteral(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.view.CView.walk().

+ Here is the call graph for this function:

◆ containsView()

final boolean org.lightjason.agentspeak.beliefbase.view.CView.containsView ( @Nonnull final IPath  p_path)
Parameters
p_pathpath to a view
Returns
existance boolean

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 197 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IBeliefbase.containsView(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.view.CView.walk().

+ Here is the call graph for this function:

◆ empty()

final boolean org.lightjason.agentspeak.beliefbase.view.CView.empty ( )
Returns
empty boolean

Implements org.lightjason.agentspeak.beliefbase.IStructure.

Definition at line 338 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IStructure.empty(), and org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase.

+ Here is the call graph for this function:

◆ equals()

final boolean org.lightjason.agentspeak.beliefbase.view.CView.equals ( final Object  p_object)

Definition at line 392 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.hashCode().

+ Here is the call graph for this function:

◆ generate()

final IView org.lightjason.agentspeak.beliefbase.view.CView.generate ( @Nonnull final IViewGenerator  p_generator,
@Nonnull final IPath...  p_paths 
)
Parameters
p_generatorgenerator for views
p_pathspaths items
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 264 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.IView.stream(), and org.lightjason.agentspeak.beliefbase.view.CView.walk().

+ Here is the call graph for this function:

◆ hashCode()

final int org.lightjason.agentspeak.beliefbase.view.CView.hashCode ( )

Definition at line 386 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.view.CView.m_name.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.equals().

+ Here is the caller graph for this function:

◆ hasParent()

final boolean org.lightjason.agentspeak.beliefbase.view.CView.hasParent ( )
Returns
boolean flag of the parent

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 380 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_parent.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.root().

+ Here is the caller graph for this function:

◆ leafview()

IView org.lightjason.agentspeak.beliefbase.view.CView.leafview ( @Nonnull final Stream< IView p_stream)
private
Parameters
p_streamstream of views
Returns
last / leaf view

Definition at line 317 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.IView.EMPTY.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.add(), org.lightjason.agentspeak.beliefbase.view.CView.clear(), org.lightjason.agentspeak.beliefbase.view.CView.containsLiteral(), org.lightjason.agentspeak.beliefbase.view.CView.containsView(), org.lightjason.agentspeak.beliefbase.view.CView.remove(), and org.lightjason.agentspeak.beliefbase.view.CView.stream().

+ Here is the caller graph for this function:

◆ name()

final String org.lightjason.agentspeak.beliefbase.view.CView.name ( )
Returns
name

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 360 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_name.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.toString().

+ Here is the caller graph for this function:

◆ parent()

final IView org.lightjason.agentspeak.beliefbase.view.CView.parent ( )
Returns
parent object or null

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 374 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_parent.

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.root().

+ Here is the caller graph for this function:

◆ path()

final IPath org.lightjason.agentspeak.beliefbase.view.CView.path ( )
Returns
path
Note
the path is relative to the root node, exclusive root element

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 367 of file CView.java.

References org.lightjason.agentspeak.common.CPath.collect(), org.lightjason.agentspeak.beliefbase.view.IView.name(), and org.lightjason.agentspeak.beliefbase.view.CView.root().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.stream(), and org.lightjason.agentspeak.beliefbase.view.CView.trigger().

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

◆ remove() [1/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.remove ( @Nonnull final IView...  p_view)
Parameters
p_viewview
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 161 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.IView.stream().

+ Here is the call graph for this function:

◆ remove() [2/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.remove ( @Nonnull final Stream< ILiteral p_literal)
Parameters
p_literalliteral stream
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 169 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.IView.beliefbase(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), org.lightjason.agentspeak.beliefbase.IBeliefbase.remove(), and org.lightjason.agentspeak.beliefbase.view.CView.walk().

+ Here is the call graph for this function:

◆ remove() [3/3]

final IView org.lightjason.agentspeak.beliefbase.view.CView.remove ( @Nonnull final ILiteral...  p_literal)
Parameters
p_literalliteral
Returns
self reference

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 178 of file CView.java.

◆ root()

final Stream<IView> org.lightjason.agentspeak.beliefbase.view.CView.root ( )
Returns
stream of views
Note
the stream is exclusive of the root node and starts with the current node

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 351 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.hasParent(), org.lightjason.agentspeak.beliefbase.view.CView.parent(), and org.lightjason.agentspeak.beliefbase.view.IView.root().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.add(), and org.lightjason.agentspeak.beliefbase.view.CView.path().

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

◆ size()

final int org.lightjason.agentspeak.beliefbase.view.CView.size ( )
Returns
size

Implements org.lightjason.agentspeak.beliefbase.IStructure.

Definition at line 344 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.IStructure.size().

+ Here is the call graph for this function:

◆ stream() [1/2]

final Stream<ILiteral> org.lightjason.agentspeak.beliefbase.view.CView.stream ( @Nullable final IPath...  p_path)
Parameters
p_pathpaths of the literals
Returns
literal stream

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 227 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.IView.beliefbase(), org.lightjason.agentspeak.beliefbase.view.CView.leafview(), org.lightjason.agentspeak.beliefbase.IBeliefbase.literal(), org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, org.lightjason.agentspeak.beliefbase.view.CView.path(), org.lightjason.agentspeak.beliefbase.IBeliefbase.streamLiteral(), org.lightjason.agentspeak.beliefbase.IBeliefbase.streamView(), and org.lightjason.agentspeak.beliefbase.view.CView.walk().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.stream().

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

◆ stream() [2/2]

final Stream<ILiteral> org.lightjason.agentspeak.beliefbase.view.CView.stream ( final boolean  p_negated,
@Nullable final IPath...  p_path 
)

◆ toString()

final String org.lightjason.agentspeak.beliefbase.view.CView.toString ( )

Definition at line 398 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.view.CView.name().

+ Here is the call graph for this function:

◆ trigger()

final Stream<ITrigger> org.lightjason.agentspeak.beliefbase.view.CView.trigger ( )
Returns
set with trigger events

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 100 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, org.lightjason.agentspeak.beliefbase.view.CView.path(), org.lightjason.agentspeak.common.IPath.remove(), and org.lightjason.agentspeak.beliefbase.IBeliefbase.trigger().

+ Here is the call graph for this function:

◆ update()

final IAgent<?> org.lightjason.agentspeak.beliefbase.view.CView.update ( @Nonnull final IAgent<?>  p_agent)
Parameters
p_agentagent which runs the update call
Returns
agent
Warning
call update on a storage and on all storage-view, if exists different views which are point to the same storage, the update is called more than once, so the storage must limit the number of update calls

Implements org.lightjason.agentspeak.beliefbase.IStructure.

Definition at line 110 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, and org.lightjason.agentspeak.beliefbase.IStructure.update().

+ Here is the call graph for this function:

◆ walk()

final Stream<IView> org.lightjason.agentspeak.beliefbase.view.CView.walk ( @Nonnull final IPath  p_path,
@Nullable final IViewGenerator...  p_generator 
)
Parameters
p_pathpath
p_generatorgenerator for view creating (first argument is used, orther elements will be ignored)
Returns
stream of views

Implements org.lightjason.agentspeak.beliefbase.view.IView.

Definition at line 257 of file CView.java.

References org.lightjason.agentspeak.beliefbase.view.CView.walkdown().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.add(), org.lightjason.agentspeak.beliefbase.view.CView.clear(), org.lightjason.agentspeak.beliefbase.view.CView.containsLiteral(), org.lightjason.agentspeak.beliefbase.view.CView.containsView(), org.lightjason.agentspeak.beliefbase.view.CView.generate(), org.lightjason.agentspeak.beliefbase.view.CView.remove(), and org.lightjason.agentspeak.beliefbase.view.CView.stream().

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

◆ walkdown()

Stream<IView> org.lightjason.agentspeak.beliefbase.view.CView.walkdown ( @Nonnull final IPath  p_path,
@Nullable final IViewGenerator...  p_generator 
)
private
Parameters
p_pathpath
p_generatorgenerator (first argument is used, other elements will be ignored)
Returns
view stream

Definition at line 280 of file CView.java.

References org.lightjason.agentspeak.beliefbase.IBeliefbase.add(), org.lightjason.agentspeak.beliefbase.IStructure.empty(), org.lightjason.agentspeak.beliefbase.view.CView.m_beliefbase, org.lightjason.agentspeak.beliefbase.IBeliefbase.viewOrDefault(), and org.lightjason.agentspeak.beliefbase.view.IView.walk().

Referenced by org.lightjason.agentspeak.beliefbase.view.CView.walk().

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

Member Data Documentation

◆ m_beliefbase

◆ m_name

final String org.lightjason.agentspeak.beliefbase.view.CView.m_name
private

◆ m_parent

final IView org.lightjason.agentspeak.beliefbase.view.CView.m_parent
private