LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.beliefbase.view.IView Interface Reference

view for a beliefbase that creates any access to the underlying data structures More...

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

Public Member Functions

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

Public Attributes

IView EMPTY
 empty view More...
 

Detailed Description

Template Parameters
Tagent type

Definition at line 44 of file IView.java.

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ add() [3/3]

IView org.lightjason.agentspeak.beliefbase.view.IView.add ( @Nonnull final IView...  p_view)
Parameters
p_viewexisting view
Returns
self reference

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ beliefbase()

IBeliefbase org.lightjason.agentspeak.beliefbase.view.IView.beliefbase ( )

◆ clear()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ containsLiteral()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

Referenced by org.lightjason.agentspeak.beliefbase.TestCViewMap.containsliteral().

+ Here is the caller graph for this function:

◆ containsView()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

Referenced by org.lightjason.agentspeak.beliefbase.TestCViewMap.containsview().

+ Here is the caller graph for this function:

◆ generate()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CView, and org.lightjason.agentspeak.beliefbase.view.CViewMap.

Referenced by org.lightjason.agentspeak.consistency.TestCMetric.agent(), and org.lightjason.agentspeak.beliefbase.TestCView.testTree().

+ Here is the caller graph for this function:

◆ hasParent()

boolean org.lightjason.agentspeak.beliefbase.view.IView.hasParent ( )

◆ name()

String org.lightjason.agentspeak.beliefbase.view.IView.name ( )
Returns
name

Implemented in org.lightjason.agentspeak.beliefbase.view.CView, and org.lightjason.agentspeak.beliefbase.view.CViewMap.

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

+ Here is the caller graph for this function:

◆ parent()

IView org.lightjason.agentspeak.beliefbase.view.IView.parent ( )

◆ path()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CView, and org.lightjason.agentspeak.beliefbase.view.CViewMap.

◆ remove() [1/3]

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

Referenced by org.lightjason.agentspeak.beliefbase.IBaseBeliefbase.internalremove(), and org.lightjason.agentspeak.beliefbase.IBaseBeliefbase.update().

+ Here is the caller graph for this function:

◆ remove() [2/3]

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ remove() [3/3]

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ root()

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

Implemented in org.lightjason.agentspeak.beliefbase.view.CView, and org.lightjason.agentspeak.beliefbase.view.CViewMap.

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

+ Here is the caller graph for this function:

◆ stream() [1/2]

◆ stream() [2/2]

Stream<ILiteral> org.lightjason.agentspeak.beliefbase.view.IView.stream ( final boolean  p_negated,
@Nullable final IPath...  p_path 
)
Parameters
p_negatednegated flag
p_pathpaths of the literals
Returns
literal stream

Implemented in org.lightjason.agentspeak.beliefbase.view.CViewMap, and org.lightjason.agentspeak.beliefbase.view.CView.

◆ trigger()

Stream<ITrigger> org.lightjason.agentspeak.beliefbase.view.IView.trigger ( )

◆ walk()

Stream<IView> org.lightjason.agentspeak.beliefbase.view.IView.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

Implemented in org.lightjason.agentspeak.beliefbase.view.CView, and org.lightjason.agentspeak.beliefbase.view.CViewMap.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ EMPTY

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

Definition at line 49 of file IView.java.

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