|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectplanet.generic.commonapi.factory.GenericFactory
It is an abstraction class that follows the Factory Method pattern. It
offers different static methods to obtain differents instances of factories
and their related objects.
From anywhere of this simulator one can use these methods to obtain the
required instance, using the current configuration attributes (using
loaded properties from planet.util.Properties).
Constructor Summary | |
GenericFactory()
|
Method Summary | |
static Application |
buildApplication()
|
static Application |
buildApplication(java.lang.String app)
|
static ApplicationFactory |
buildApplicationFactory()
Builds a new instance of ApplicationFactory following the current configuration. |
static Application |
buildApplicationWithName(java.lang.String name)
|
static Application |
buildApplicationWithName(java.lang.String app,
java.lang.String name)
|
static BehavioursFactory |
buildBehavioursFactory()
Builds an instance of the current BehavioursFactory implementation. |
static BehavioursFilter |
buildBehavioursFilter()
|
static BehavioursInvoker |
buildBehavioursInvoker()
|
static BehavioursPattern |
buildBehavioursPattern()
|
static BehavioursPool |
buildBehavioursPool()
|
static BehavioursRoleSelector |
buildBehavioursRoleSelector()
|
static ResultsConstraint |
buildConstraint(java.lang.String resultsName)
|
static java.util.Iterator |
buildDistributedIds(int desiredNetworkSize)
|
static ResultsEdge |
buildEdge(java.lang.String resultsName,
Id source,
Id target,
boolean directed,
java.lang.String fill)
|
static EndPoint |
buildEndPoint(Application app,
Node node)
|
static EndPointFactory |
buildEndPointFactory()
Builds a new instance of EndPointFactory following the current configuration. |
static ResultsGenerator |
buildGenerator(java.lang.String resultsName)
|
static Id |
buildId()
|
static Id |
buildId(java.math.BigInteger bigNumber)
|
static Id |
buildId(byte[] material)
|
static Id |
buildId(double material)
|
static Id |
buildId(int material)
|
static Id |
buildId(int[] material)
|
static Id |
buildId(java.lang.String string)
|
static Id |
buildId(java.lang.String material,
java.lang.String algorithm)
|
static IdFactory |
buildIdFactory()
Builds a new instance of IdFactory. |
static Id |
buildKey(java.lang.String string)
|
static Network |
buildNetwork()
|
static Network |
buildNetwork(int size)
|
static Network |
buildNetwork(int size,
NodeFactory nodeFactory)
|
static Network |
buildNetwork(int size,
NodeFactory nodeFactory,
java.lang.String topology)
|
static Network |
buildNetwork(int size,
java.lang.String topology)
|
static NetworkFactory |
buildNetworkFactory()
Builds a new instance of NetworkFactory. |
static Node |
buildNode()
|
static Node |
buildNode(Id id)
|
static NodeFactory |
buildNodeFactory()
Builds a new instance of NodeFactory following the current configuration. |
static NodeHandle |
buildNodeHandle(Id nodeId,
boolean alive)
|
static NodeHandleFactory |
buildNodeHandleFactory()
Builds a new instance of NodeHandleFactory following the current configuration. |
static Id |
buildRandomId()
|
static ResultsFactory |
buildResultsFactory(java.lang.String resultName)
Builds an instance of the current BehavioursFactory implementation. |
static RouteMessagePool |
buildRouteMessagePool()
Builds an instance of the current RouteMessagePool implementation. |
static void |
freeMessage(RouteMessage msg)
|
static java.lang.String |
generateKey()
Generate a unique key, based on a simple int. |
static void |
generateResults(java.lang.String resultsName,
Network network,
java.lang.String out,
ResultsConstraint constraint,
boolean wholeNetworkLayout)
|
static int |
getBuiltRouteMessages()
|
static ApplicationFactory |
getDefaultApplicationFactory()
Returns the ApplicationFactory that is used internally to invoke the application factory methods. |
static BehavioursFactory |
getDefaultBehavioursFactory()
Return the BehavioursFactory that is used internally to invoke the behaviours factory methods. |
static BehavioursPool |
getDefaultBehavioursPool()
Return the BehavioursPool that is used internally to invoke the behaviours pool methods. |
static EndPointFactory |
getDefaultEndPointFactory()
Return the EndPointFactory that is used internally to invoke the endpoint factory methods. |
static IdFactory |
getDefaultIdFactory()
Returns the IdFactory that is used internally to invoke the IdFactory methods. |
static NetworkFactory |
getDefaultNetworkFactory()
Returns the NetworkFactory that is used internally to invoke the NetworkFactory methods. |
static NodeFactory |
getDefaultNodeFactory()
Returns the NodeFactory that is used internally to invoke the node factory methods. |
static NodeHandleFactory |
getDefaultNodeHandleFactory()
Returns the NodeHandleFactory that is used internally to invoke the nodehandle factory methods. |
static RouteMessagePool |
getDefaultRouteMessagePool()
Returns the RouteMessagePool that is used internally to invoke the pool methods. |
static int |
getFreeRouteMessages()
|
static RouteMessage |
getMessage(java.lang.String key,
NodeHandle from,
NodeHandle to,
int type,
int mode)
|
static RouteMessage |
getMessage(java.lang.String key,
NodeHandle from,
NodeHandle to,
NodeHandle nextHop,
Message msg,
int type,
int mode,
java.lang.String appId)
|
static int |
getReusedRouteMessages()
|
static void |
init()
Initialize the GenericFactory to load the default properties file. |
static java.lang.Object |
newInstance(java.lang.Class classReference)
Builds an instance of the specified class. |
void |
onMessage(RouteMessage msg,
Node node)
|
static void |
postinit()
Make the post initializations to leave the GenericFactory complete. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public GenericFactory()
Method Detail |
public static java.lang.Object newInstance(java.lang.Class classReference) throws InitializationException
return classReference.newInstance();
classReference
- The class reference to use to build the new instance.
InitializationException
- if any error occurs during the
initialization process, or when the classReference has a null value.public static void init() throws InitializationException
InitializationException
- if occurs any problem during initialization.public static void postinit() throws InitializationException
InitializationException
- if some error occurs during the
initialization.public static NetworkFactory buildNetworkFactory() throws InitializationException
InitializationException
- if occurs some problem with the factory initialization.public static Network buildNetwork() throws InitializationException
InitializationException
NetworkFactory.buildNetwork()
public static Network buildNetwork(int size) throws InitializationException
InitializationException
NetworkFactory.buildNetwork(int)
public static Network buildNetwork(int size, NodeFactory nodeFactory) throws InitializationException
InitializationException
NetworkFactory.buildNetwork(int,
planet.commonapi.factory.NodeFactory)
public static Network buildNetwork(int size, java.lang.String topology) throws InitializationException
InitializationException
NetworkFactory.buildNetwork(int,
java.lang.String)
public static Network buildNetwork(int size, NodeFactory nodeFactory, java.lang.String topology) throws InitializationException
InitializationException
NetworkFactory.buildNetwork(int,
planet.commonapi.factory.NodeFactory, java.lang.String)
public static IdFactory buildIdFactory() throws InitializationException
InitializationException
- if occurs some problem with the
factory initialization.public static Id buildId() throws InitializationException
InitializationException
IdFactory.buildId()
public static Id buildId(int material) throws InitializationException
InitializationException
IdFactory.buildId(int)
public static Id buildId(double material) throws InitializationException
InitializationException
IdFactory.buildId(double)
public static Id buildId(byte[] material) throws InitializationException
InitializationException
IdFactory.buildId(byte[])
public static Id buildId(int[] material) throws InitializationException
InitializationException
IdFactory.buildId(int[])
public static Id buildKey(java.lang.String string) throws InitializationException
InitializationException
IdFactory.buildKey(java.lang.String)
public static Id buildId(java.lang.String string) throws InitializationException
InitializationException
IdFactory.buildId(java.lang.String)
public static Id buildId(java.math.BigInteger bigNumber) throws InitializationException
InitializationException
IdFactory.buildId(java.math.BigInteger)
public static Id buildId(java.lang.String material, java.lang.String algorithm) throws InitializationException
InitializationException
IdFactory.buildId(java.lang.String,java.lang.String)
,
Java Cryptography Architecture API Specification & Reference public static Id buildRandomId() throws InitializationException
InitializationException
IdFactory.buildRandomId()
public static java.util.Iterator buildDistributedIds(int desiredNetworkSize) throws InitializationException
InitializationException
IdFactory.buildDistributedIds(int)
public static NodeHandleFactory buildNodeHandleFactory() throws InitializationException
InitializationException
- if some error occurs during
the initialization process.public static NodeHandle buildNodeHandle(Id nodeId, boolean alive) throws InitializationException
InitializationException
NodeHandleFactory.buildNodeHandle(planet.commonapi.Id,boolean)
public static NodeFactory buildNodeFactory() throws InitializationException
InitializationException
- if some error occurs during
the initialization process.public static Node buildNode() throws InitializationException
InitializationException
NodeFactory.buildNode()
public static Node buildNode(Id id) throws InitializationException
InitializationException
NodeFactory.buildNode(planet.commonapi.Id)
public static RouteMessagePool buildRouteMessagePool() throws InitializationException
InitializationException
- if any errors occurs during the
initialization process.public static void freeMessage(RouteMessage msg)
RouteMessagePool.freeMessage(planet.commonapi.RouteMessage)
public static RouteMessage getMessage(java.lang.String key, NodeHandle from, NodeHandle to, int type, int mode) throws InitializationException
InitializationException
RouteMessagePool.getMessage(java.lang.String, planet.commonapi.NodeHandle, planet.commonapi.NodeHandle, int, int)
public static RouteMessage getMessage(java.lang.String key, NodeHandle from, NodeHandle to, NodeHandle nextHop, Message msg, int type, int mode, java.lang.String appId) throws InitializationException
InitializationException
RouteMessagePool.getMessage(String, NodeHandle, NodeHandle, NodeHandle, int, int, Message, String)
public static int getBuiltRouteMessages()
RouteMessagePool.getBuiltRouteMessages()
public static int getFreeRouteMessages()
RouteMessagePool.getFreeRouteMessages()
public static int getReusedRouteMessages()
RouteMessagePool.getReusedRouteMessages()
public static ApplicationFactory buildApplicationFactory() throws InitializationException
InitializationException
- if some error occurs during
the initialization process.public static Application buildApplication() throws InitializationException
InitializationException
ApplicationFactory.buildApplication()
public static Application buildApplication(java.lang.String app) throws InitializationException
InitializationException
ApplicationFactory.buildApplication(java.lang.String)
public static Application buildApplicationWithName(java.lang.String name) throws InitializationException
InitializationException
ApplicationFactory.buildApplicationWithName(java.lang.String)
public static Application buildApplicationWithName(java.lang.String app, java.lang.String name) throws InitializationException
InitializationException
ApplicationFactory.buildApplicationWithName(java.lang.String,
java.lang.String)
public static EndPointFactory buildEndPointFactory() throws InitializationException
InitializationException
- if some error occurs during
the initialization process.public static EndPoint buildEndPoint(Application app, Node node) throws InitializationException
InitializationException
EndPointFactory.buildEndPoint(planet.commonapi.Application,planet.commonapi.Node)
public static BehavioursFactory buildBehavioursFactory() throws InitializationException
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the current overlay doesn't use behaviours.public static BehavioursFilter buildBehavioursFilter() throws InitializationException
InitializationException
BehavioursFactory.buildBehavioursFilter()
public static BehavioursInvoker buildBehavioursInvoker() throws InitializationException
InitializationException
BehavioursFactory.buildBehavioursInvoker()
public static BehavioursPattern buildBehavioursPattern() throws InitializationException
InitializationException
BehavioursFactory.buildBehavioursPattern()
public static BehavioursPool buildBehavioursPool() throws InitializationException
InitializationException
BehavioursFactory.buildBehavioursPool()
public static BehavioursRoleSelector buildBehavioursRoleSelector() throws InitializationException
InitializationException
BehavioursFactory.buildBehavioursRoleSelector()
public void onMessage(RouteMessage msg, Node node) throws NoSuchBehaviourException, NoBehaviourDispatchedException, InitializationException
NoSuchBehaviourException
NoBehaviourDispatchedException
InitializationException
BehavioursPool.onMessage(planet.commonapi.RouteMessage, planet.commonapi.Node)()
public static ResultsFactory buildResultsFactory(java.lang.String resultName) throws InitializationException
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the no results are activated, or when the resultsName doesn't
appears in the current configuration.public static void generateResults(java.lang.String resultsName, Network network, java.lang.String out, ResultsConstraint constraint, boolean wholeNetworkLayout) throws InitializationException
resultsName
- Results type name to use.
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the no results are activated, or when the resultsName doesn't
appears in the current configuration.ResultsGenerator.generateResults(planet.commonapi.Network, java.lang.String, planet.commonapi.results.ResultsConstraint, boolean)
public static ResultsEdge buildEdge(java.lang.String resultsName, Id source, Id target, boolean directed, java.lang.String fill) throws InitializationException
resultsName
- Results type name to use.
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the no results are activated, or when the resultsName doesn't
appears in the current configuration.ResultsFactory.buildEdge(planet.commonapi.Id, planet.commonapi.Id, boolean, java.lang.String)
public static ResultsGenerator buildGenerator(java.lang.String resultsName) throws InitializationException
resultsName
- Results type name to use.
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the no results are activated, or when the resultsName doesn't
appears in the current configuration.ResultsFactory.buildGenerator()
public static ResultsConstraint buildConstraint(java.lang.String resultsName) throws InitializationException
resultsName
- Results type name to use.
InitializationException
- when an error occurs during the
initialization or when this factory method is nonapplicable, because
the no results are activated, or when the resultsName doesn't
appears in the current configuration.ResultsFactory.buildConstraint()
public static java.lang.String generateKey()
public static NetworkFactory getDefaultNetworkFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static IdFactory getDefaultIdFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static NodeHandleFactory getDefaultNodeHandleFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static NodeFactory getDefaultNodeFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static ApplicationFactory getDefaultApplicationFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static EndPointFactory getDefaultEndPointFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static BehavioursFactory getDefaultBehavioursFactory() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static BehavioursPool getDefaultBehavioursPool() throws InitializationException
InitializationException
- if some error occurs during the retrieving.public static RouteMessagePool getDefaultRouteMessagePool() throws InitializationException
InitializationException
- if some error occurs during the retrieving.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |