org.myrobotlab.framework.repo

Class ServiceData

java.lang.Object

org.myrobotlab.framework.repo.ServiceData

All Implemented Interfaces:

Serializable

public class ServiceData
extends Object
implements Serializable

ServiceData class contains all of the Services meta data. This includes : 1. Dependency information - what libraries are needed to run the class 2. Categories of the service 3. Peers of the service All this information is Service "type" related - non of it is instance specific. ServiceData has to be created during "build" time since most of the services contain dependencies which might not be fulfilled during runtime. ServiceData.generate() creates serviceData.json which is packaged by the build in : /resource/framework/serviceData.json When MyRobotLab runs for the first time, it will extract this file into the .myrobotlab directory.

Author:

GroG

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ServiceData()

Method Summary

Modifier and Type	Method and Description
void	add(ServiceType serviceType)
boolean	containsServiceType(String fullServiceName)
static ServiceData	generate() This method has to check the environment first in order to tell if its Develop-Time or Run-Time because the method of generating a service list is different depending on current environment Develop-Time can simply filter and process the files on the file system given by the code source location Run-Time must extract itself and scan/filter zip entries which is potentially a lengthy process, and should only have to be done once for the lifetime of the version or mrl
List<ServiceType>	getAvailableServiceTypes()
List<Category>	getCategories()
Category	getCategory(String filter)
String[]	getCategoryNames()
static List<ServiceDependency>	getDependencyKeys(String fullTypeName)
static ServiceData	getLocalInstance()
static ServiceType	getMetaData(String serviceTypeName)
ServiceType	getServiceType(String fullTypeName)
HashSet<ServiceDependency>	getServiceTypeDependencyKeys()
String[]	getServiceTypeNames()
String[]	getServiceTypeNames(String categoryFilterName)
List<ServiceType>	getServiceTypes()
List<ServiceType>	getServiceTypes(boolean showUnavailable)
static void	main(String[] args)
boolean	save()
boolean	save(String filename)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final transient org.slf4j.Logger log

Constructor Detail

ServiceData

public ServiceData()

Method Detail

getLocalInstance

public static ServiceData getLocalInstance()

generate

public static ServiceData generate()
                            throws IOException

This method has to check the environment first in order to tell if its Develop-Time or Run-Time because the method of generating a service list is different depending on current environment Develop-Time can simply filter and process the files on the file system given by the code source location Run-Time must extract itself and scan/filter zip entries which is potentially a lengthy process, and should only have to be done once for the lifetime of the version or mrl

Returns:

the service data description

Throws:

IOException - e

add

public void add(ServiceType serviceType)

containsServiceType

public boolean containsServiceType(String fullServiceName)

getAvailableServiceTypes

public List<ServiceType> getAvailableServiceTypes()

getCategory

public Category getCategory(String filter)

getCategoryNames

public String[] getCategoryNames()

getServiceTypeDependencyKeys

public HashSet<ServiceDependency> getServiceTypeDependencyKeys()

getServiceTypeNames

public String[] getServiceTypeNames()

getServiceTypeNames

public String[] getServiceTypeNames(String categoryFilterName)

getServiceType

public ServiceType getServiceType(String fullTypeName)

getServiceTypes

public List<ServiceType> getServiceTypes()

getServiceTypes

public List<ServiceType> getServiceTypes(boolean showUnavailable)

save

public boolean save()

save

public boolean save(String filename)

getCategories

public List<Category> getCategories()

getDependencyKeys

public static List<ServiceDependency> getDependencyKeys(String fullTypeName)

getMetaData

public static ServiceType getMetaData(String serviceTypeName)

main

public static void main(String[] args)