NetworkAimlFacade Class Reference

Facade to manage the memory allocation and deallocation of concrete objects that have publicly exposed interfaces as well as provide get'ers to the concrete objects using their exposed interfaces. More...

List of all members.

Public Member Functions

void destroy () throws Exception
 Destroys the facade and all the concrete objects to the interfaces that have get'ers.
NetworkGraphBuilder getNetworkGraphBuilder ()
 Returns the constructed GraphBuilder object from NetworkAimlFacade's constructor.
 NetworkAimlFacade (String[] args) throws NetworkException, Exception
 Constructs the facade and all the concrete objects to the interfaces that have get'ers.

Private Attributes

NetworkGraphBuilderAIML graphBuilder
 The GraphBuilder reference.


Detailed Description

Facade to manage the memory allocation and deallocation of concrete objects that have publicly exposed interfaces as well as provide get'ers to the concrete objects using their exposed interfaces.

NetworkAimlFacade manages the memory for the GraphBuilder object. When NetworkAimlFacade is instantiated it creates the GraphBuilder concrete implementation with a "new" and stores it inside of its reference to the GraphBuilder interface, graphBuilder. When NetworkAimlFacade is destroyed it in turn destroys the GraphBuilder object through this same reference.

This indirection is needed since GraphBuilder is an interface and users cannot directly instantiate it without access to a concrete implementation.


Constructor & Destructor Documentation

NetworkAimlFacade ( String[]  args  )  throws NetworkException, Exception [inline]

Constructs the facade and all the concrete objects to the interfaces that have get'ers.

Underneath the covers the constructor creates a factory and from that factor creates the GraphBuilder concrete representation and stores it in the graphBuilder reference. Pass in your args from your main() to this constructor so it can parse any commands it might want. If you don't have access to your arguments from main() you can "fake" it by passing in a string with the name of your program to args.

Parameters:
args Pass this from your main()
Exceptions:
NetworkException If it cannot contact the server upon construction to make the initial connection it will throw a network exception with the message of why it cannot contact the server.
Exception If an underlying method throws an exception, it will be wrapped and thrown as a Exception.


Member Function Documentation

void destroy (  )  throws Exception [inline]

Destroys the facade and all the concrete objects to the interfaces that have get'ers.

Underneath the covers it removes the GraphBuilder and its respective factory which created it.

NetworkGraphBuilder getNetworkGraphBuilder (  )  [inline]

Returns the constructed GraphBuilder object from NetworkAimlFacade's constructor.

Returns:
The GraphBuilder constructed in the NetworkAimlFacade constructor.
Exceptions:
No exceptions will be thrown.


Member Data Documentation

NetworkGraphBuilderAIML graphBuilder [private]

The GraphBuilder reference.

Use NetworkAimlFacade.getGraphBuilder to obtain a reference to this. The GraphBuilder object is constructed in the constructor of NetworkAimlFacade


The documentation for this class was generated from the following file:
Generated on Mon Aug 27 12:26:44 2007 for RebeccaAIML by  doxygen 1.5.3