Inheritance diagram for roboearth.wp5.conn.REConnectionHadoop:

Classes
class	EnvironmentList
class	ObjectList
class	RecipeList
class	RobotList
Public Member Functions
boolean	deleteActionRecipe (String uid)
boolean	deleteEnvironment (String uid)
boolean	deleteEnvironmentBinaryFile (String envUid, String fileID)
boolean	deleteObject (String uid)
boolean	deleteObjectBinaryFile (String objectUid, String fileID)
String	queryActionRecipeDB (String seRQLquery)
String	queryEnvironmentDB (String seRQLquery)
String	queryObjectDB (String seRQLquery)
	REConnectionHadoop (String apiKey)
ArrayList< byte[]>	request2dMap (String envUid, OWLOntology srdl, String baseScannerLink, String simpleMapNameWithoutExt)
String	requestActionRecipe (String uid)
String	requestActionRecipeFromURL (String url)
byte[]	requestBinaryFile (URL fileURL)
File	requestBinaryFile (URL fileURL, String targetPath)
String	requestEnvironment (String uid)
String	requestEnvironment (String uid, ArrayList< String > outFilenames, ArrayList< String > outFileURLs)
byte[]	requestEnvironmentBinaryFile (String envUID, String filename)
File	requestEnvironmentBinaryFile (String envUID, String filename, String targetPath)
String	requestEnvironmentFromURL (String url)
String	requestEnvironmentFromURL (String url, ArrayList< String > outFilenames, ArrayList< String > outFileURLs)
String	requestObject (String uid)
String	requestObject (String uid, ArrayList< String > outFilenames, ArrayList< String > outFileURLs)
byte[]	requestObjectBinaryFile (String objectUID, String filename)
File	requestObjectBinaryFile (String objectUID, String filename, String targetPath)
String	requestObjectFromURL (String url)
String	requestObjectFromURL (String url, ArrayList< String > outFilenames, ArrayList< String > outFileURLs)
ArrayList< byte[]>	requestProjected2dMap (String envUid, double minZ, double maxZ, String simpleMapNameWithoutExt)
String	requestRobot (String uid)
String	requestRobotFromURL (String url)
String[]	searchActionRecipes (String searchID, ArrayList< String > outUIDs)
String[]	searchEnvironments (String searchID, ArrayList< String > outUIDs, ArrayList< ArrayList< String >> outFilenames, ArrayList< ArrayList< String >> outFileURLs)
String[]	searchObjects (String searchID, ArrayList< String > outUIDs, ArrayList< ArrayList< String >> outFilenames, ArrayList< ArrayList< String >> outFileURLs)
boolean	submitActionRecipe (OWLOntology actionRecipe, String cls, String id, String description)
boolean	submitActionRecipe (String owlData, String cls, String id, String description)
boolean	submitEnvironment (OWLOntology map, String cls, String id, String description)
boolean	submitEnvironment (String owlData, String cls, String id, String description)
boolean	submitEnvironment (OWLOntology map, String cls, String id, String description, ArrayList< File > binaryFiles)
boolean	submitEnvironment (String owlData, String cls, String id, String description, ArrayList< File > binaryFiles)
boolean	submitEnvironment (OWLOntology map, String cls, String id, String description, ArrayList< byte[]> binaryData, ArrayList< String > filenames)
boolean	submitEnvironment (String owlData, String cls, String id, String description, ArrayList< byte[]> binaryData, ArrayList< String > filenames)
boolean	submitEnvironmentBinaryFile (String uid, final File file)
boolean	submitEnvironmentBinaryFile (String uid, final byte[] data, String filename)
boolean	submitObject (OWLOntology object, String cls, String id, String description)
boolean	submitObject (String owlData, String cls, String id, String description)
boolean	submitObject (OWLOntology object, String cls, String id, String description, ArrayList< File > binaryFiles)
boolean	submitObject (String owlData, String cls, String id, String description, ArrayList< File > binaryFiles)
boolean	submitObject (OWLOntology object, String cls, String id, String description, ArrayList< byte[]> binaryData, ArrayList< String > filenames)
boolean	submitObject (String owlData, String cls, String id, String description, ArrayList< byte[]> binaryData, ArrayList< String > filenames)
boolean	submitObjectBinaryFile (String uid, final File file)
boolean	submitObjectBinaryFile (String uid, final byte[] data, String filename)
boolean	updateActionRecipe (String uid, OWLOntology actionRecipe, String description)
boolean	updateActionRecipe (String uid, String owlData, String description)
boolean	updateEnvironment (String uid, OWLOntology env, String description)
boolean	updateEnvironment (String uid, String owlData, String description)
boolean	updateEnvironmentBinaryFile (String uid, File file)
boolean	updateEnvironmentBinaryFile (String uid, byte[] data, String filename)
boolean	updateObject (String uid, OWLOntology object, String description)
boolean	updateObject (String uid, String object, String description)
boolean	updateObjectBinaryFile (String uid, File file)
boolean	updateObjectBinaryFile (String uid, byte[] data, String filename)
Static Public Member Functions
static boolean	isHTTPRequestProcessedCorrectly (HttpResponse response)
Static Public Attributes
static final String	mapExtractorSuffix = "/api/service/3dto2dmap"
static final String	querySuffix = "/api/serql"
static final String	requestActionRecipeSuffix = "/api/recipe/"
static final String	requestEnvironmentBinariesSuffix = "/data/environments/"
static final String	requestEnvironmentSuffix = "/api/environment/"
static final String	requestObjectBinariesSuffix = "/data/objects/"
static final String	requestObjectSuffix = "/api/object/"
static final String	requestRobotSuffix = "/api/robot/"
static final String	roboEarthBaseURL = "http://api.roboearth.org"
static final String	submitActionRecipeSuffix = "/api/recipe"
static final String	submitEnvironmentBinariesSuffix = "/api/binary/environments/"
static final String	submitEnvironmentSuffix = "/api/environment"
static final String	submitObjectBinariesSuffix = "/api/binary/objects/"
static final String	submitObjectSuffix = "/api/object"
static final int	timoutInMs = 60000
Protected Member Functions
boolean	submitBinaryFile (String url, InputStreamBody isb)
Static Protected Member Functions
static boolean	deleteData (String deleteURL)
static String	querySemanticDB (String seRQLquery, String repository)
static String	requestData (String requestURL)
static String	requestService (String jsonData, String url)
static boolean	submitData (String jsonData, String submitURL)
static boolean	updateData (String jsonData, String updateURL)
Private Attributes
final String	apiKey
Static Private Attributes
static final String	fileIdObjArticModel = "articulationModel"
static final String	fileIdObjImage = "image"
static final String	fileIdObjModel = "model"
static final JsonFormatter	JSON_FORMATTER = new PrettyJsonFormatter()
static final JdomParser	json_parser = new JdomParser()

Detailed Description

The REConnectionHadoop class provides means to interact with the RoboEarth DB provided by an Apache Hadoop based implementation. It contains methods to submit and retrieve all supported kinds of information relevant to the RoboEarth project.

Author:: Alexander Perzylo, perzylo@cs.tum.edu

Definition at line 116 of file REConnectionHadoop.java.

Constructor & Destructor Documentation

roboearth.wp5.conn.REConnectionHadoop.REConnectionHadoop ( String apiKey ) [inline]

Creates a RoboEarth connection and assigns an API key for authentication at the RoboEarth DB. You may get your API key at: http://roboearth.informatik.uni-stuttgart.de

You can also pass in a null reference. Then it would be possible to request data from the RoboEarth DB, but submitting data will fail.

Parameters:

apiKey API key for the RoboEarth DB

Definition at line 226 of file REConnectionHadoop.java.

Member Function Documentation

boolean roboearth.wp5.conn.REConnectionHadoop.deleteActionRecipe ( String uid ) [inline]

Deletes an action recipe from the RoboEarth DB.

Parameters:

uid	the action recipe's unique identifier

Returns:: true - if the recipe was successfully deleted
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1335 of file REConnectionHadoop.java.

static boolean roboearth.wp5.conn.REConnectionHadoop.deleteData ( String deleteURL ) [inline, static, protected]

Deletes an entry from the RoboEarth DB via a HTTP Delete request.

Parameters:

deleteURL URL of RoboEarth DB entry to delete

Returns:: true - if DB entry was successfully deleted, false - otherwise

Definition at line 1371 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.deleteEnvironment ( String uid ) [inline]

Deletes an environment from the RoboEarth DB.

Parameters:

uid	the environment's unique identifier

Returns:: true - if the environment was successfully deleted
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1347 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.deleteEnvironmentBinaryFile	(	String	uid,
		String	filename
	)		`[inline]`

Deletes a binary file which is related to the specified environment description.

Parameters:

uid	the environment's unique identifier
filename	the unique filename (among all files related to the specified environment)

Returns:: true - if the file was successfully deleted
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1359 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.deleteObject ( String uid ) [inline]

Deletes an object description from the RoboEarth DB. All linked binary files get deleted, too.

Parameters:

uid	the object's unique identifier

Returns:: true - if the object description was successfully deleted
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1341 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.deleteObjectBinaryFile	(	String	uid,
		String	filename
	)		`[inline]`

Deletes a binary file which is related to the specified object description.

Parameters:

uid	the object's unique identifier
filename	the unique filename (among all files related to the specified object)

Returns:: true - if the file was successfully deleted
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1353 of file REConnectionHadoop.java.

static boolean roboearth.wp5.conn.REConnectionHadoop.isHTTPRequestProcessedCorrectly ( HttpResponse response ) [inline, static]

Examines a HTTP response and analyzes whether the preceding request was processed successfully.

Parameters:

response a HTTP response

Returns:: true - if HTTP response's status code is greater or equal than 200 and lower than 300
false - otherwise

Definition at line 1913 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.queryActionRecipeDB ( String seRQLquery ) [inline]

Sends the given SeRQL query to the RoboEarth DB and retrieves the result of the server-side reasoning on action recipes.

Parameters:

seRQLquery a SeRQL query

Returns:: result as a String

Implements roboearth.wp5.conn.REInterface.

Definition at line 1254 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.queryEnvironmentDB ( String seRQLquery ) [inline]

Sends the given SeRQL query to the RoboEarth DB and retrieves the result of the server-side reasoning on environments.

Parameters:

seRQLquery a SeRQL query

Returns:: result as a String

Implements roboearth.wp5.conn.REInterface.

Definition at line 1265 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.queryObjectDB ( String seRQLquery ) [inline]

Sends the given SeRQL query to the RoboEarth DB and retrieves the result of the server-side reasoning on objects.

Parameters:

seRQLquery a SeRQL query

Returns:: result as a String

Implements roboearth.wp5.conn.REInterface.

Definition at line 1259 of file REConnectionHadoop.java.

static String roboearth.wp5.conn.REConnectionHadoop.querySemanticDB	(	String	seRQLquery,
		String	repository
	)		`[inline, static, protected]`

Sends the given SeRQL query to the RoboEarth DB via a HTTP Post request.

Parameters:

seRQLquery	a SeRQL query
repository	the name of the repository to query (must be 'recipes', 'objects' or 'environments')

Returns:: result as a String

Definition at line 1277 of file REConnectionHadoop.java.

ArrayList<byte[]> roboearth.wp5.conn.REConnectionHadoop.request2dMap	(	String	envUid,
		OWLOntology	srdl,
		String	baseScannerLink,
		String	simpleMapNameWithoutExt
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 1785 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestActionRecipe ( String uid ) [inline]

Requests an action recipe.

Parameters:

uid	the action recipe's unique identifier

Returns:: String object containing OWL description of an action recipe

Implements roboearth.wp5.conn.REInterface.

Definition at line 239 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestActionRecipeFromURL ( String url ) [inline]

Requests an action recipe.

Parameters:

url	the URL of the requested action recipe

Returns:: String object containing OWL description of an action recipe

Definition at line 254 of file REConnectionHadoop.java.

byte [] roboearth.wp5.conn.REConnectionHadoop.requestBinaryFile ( URL fileURL ) [inline]

Requests a binary file.

Parameters:

fileURL the URL of the requested file

Returns:: the content of the requested file in a byte array

Definition at line 552 of file REConnectionHadoop.java.

File roboearth.wp5.conn.REConnectionHadoop.requestBinaryFile	(	URL	fileURL,
		String	targetPath
	)		`[inline]`

Requests a binary file.

Parameters:

fileURL	the URL of the requested file
targetPath	the local path to store the file

Returns:: the requested file or null, if the file couldn't be found

Definition at line 604 of file REConnectionHadoop.java.

static String roboearth.wp5.conn.REConnectionHadoop.requestData ( String requestURL ) [inline, static, protected]

Requests data from the given URL via a HTTP Get request.

Parameters:

requestURL URL to request from

Returns:: JSON encoded data

Definition at line 785 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestEnvironment ( String uid ) [inline]

Definition at line 286 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestEnvironment	(	String	uid,
		ArrayList< String >	outFilenames,
		ArrayList< String >	outFileURLs
	)		`[inline]`

Requests information about an environment. The names and URLs of binary files related to the requested environment will be put into the given lists. Any element that might be in the lists before the method call will be removed first. Both list parameters may be null. In this case only the OWL encoded description is requested.

Parameters:

uid	the environment's identifier
outFilenames	this list will be used to return the names of associated files
outFileURLs	this list will be used to return the URLs of associated files

Returns:: String object containing OWL description of environmental data

Implements roboearth.wp5.conn.REInterface.

Definition at line 304 of file REConnectionHadoop.java.

byte [] roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentBinaryFile	(	String	envUID,
		String	filename
	)		`[inline]`

Requests an environment related binary file.

Parameters:

envUID	the environment's ID the file is related to
filename	the unique filename (among all files related to the specified environment)

Returns:: the content of the requested file in a byte array

Implements roboearth.wp5.conn.REInterface.

Definition at line 725 of file REConnectionHadoop.java.

File roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentBinaryFile	(	String	envUID,
		String	filename,
		String	targetPath
	)		`[inline]`

Requests an environment related binary file.

Parameters:

envUID	the environment's ID the file is related to
filename	the unique filename (among all files related to the specified environment)
targetPath	the path where the file shall be stored

Returns:: the requested file or null, if the file couldn't be found

Implements roboearth.wp5.conn.REInterface.

Definition at line 752 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentFromURL ( String url ) [inline]

Requests a description of an environment.

Parameters:

url	the URL of the requested environment

Returns:: String object containing OWL description of environmental data

Definition at line 319 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentFromURL	(	String	url,
		ArrayList< String >	outFilenames,
		ArrayList< String >	outFileURLs
	)		`[inline]`

Requests information about an environment. The names and URLs of binary files related to the environment represented by its own URL will be put into the given lists. Any element that might be in the lists before the method call will be removed first. Both list parameters may be null. In this case only the OWL encoded description is requested.

Parameters:

url	the environment's URL
outFilenames	this list will be used to return the names of associated files
outFileURLs	this list will be used to return the URLs of associated files

Returns:: String object containing OWL description of environmental data

Definition at line 337 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestObject ( String uid ) [inline]

Requests information about an object.

Parameters:

uid	the object's unique identifier

Returns:: String object containing OWL description of the object

Definition at line 448 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestObject	(	String	uid,
		ArrayList< String >	outFilenames,
		ArrayList< String >	outFileURLs
	)		`[inline]`

Requests information about an object. The names and URLs of binary files related to the given uid will be put into the given lists. Any element that might be in the lists before the method call will be removed first. Both list parameters may be null. In this case only the OWL encoded description is requested.

Parameters:

uid	the object's unique identifier
outFilenames	this list will be used to return the names of associated files
outFileURLs	this list will be used to return the URLs of associated files

Returns:: String object containing OWL description of the object

Implements roboearth.wp5.conn.REInterface.

Definition at line 453 of file REConnectionHadoop.java.

byte [] roboearth.wp5.conn.REConnectionHadoop.requestObjectBinaryFile	(	String	objectUID,
		String	filename
	)		`[inline]`

Requests an object related binary file.

Parameters:

objectUID	the object's ID the file is related to
filename	the unique filename (among all files related to the specified object)

Returns:: the content of the requested file in a byte array

Implements roboearth.wp5.conn.REInterface.

Definition at line 671 of file REConnectionHadoop.java.

File roboearth.wp5.conn.REConnectionHadoop.requestObjectBinaryFile	(	String	objectUID,
		String	filename,
		String	targetPath
	)		`[inline]`

Requests an object related binary file.

Parameters:

objectUID	the object's ID the file is related to
filename	the unique filename (among all files related to the specified object)
targetPath	the path where the file shall be stored

Returns:: the requested file or null, if the file couldn't be found

Implements roboearth.wp5.conn.REInterface.

Definition at line 698 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestObjectFromURL ( String url ) [inline]

Requests information about an object.

Parameters:

url	the object's URL

Returns:: String object containing OWL description of the object

Definition at line 469 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestObjectFromURL	(	String	url,
		ArrayList< String >	outFilenames,
		ArrayList< String >	outFileURLs
	)		`[inline]`

Requests information about an object. The names and URLs of binary files related to the object represented by its own URL will be put into the given lists. Any element that might be in the lists before the method call will be removed first. Both list parameters may be null. In this case only the OWL encoded description is requested.

Parameters:

url	the object's URL
outFilenames	this list will be used to return the names of associated files
outFileURLs	this list will be used to return the URLs of associated files

Returns:: String object containing OWL description of the object

Definition at line 487 of file REConnectionHadoop.java.

ArrayList<byte[]> roboearth.wp5.conn.REConnectionHadoop.requestProjected2dMap	(	String	envUid,
		double	minZ,
		double	maxZ,
		String	simpleMapNameWithoutExt
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 1826 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestRobot ( String uid ) [inline]

Requests a robot description.

Parameters:

uid	the robot's unique identifier

Returns:: String object containing SRDL description of a robot

Implements roboearth.wp5.conn.REInterface.

Definition at line 396 of file REConnectionHadoop.java.

String roboearth.wp5.conn.REConnectionHadoop.requestRobotFromURL ( String url ) [inline]

Requests a robot description.

Parameters:

url	the URL of the requested robot description

Returns:: String object containing SRDL description of a robot

Definition at line 411 of file REConnectionHadoop.java.

static String roboearth.wp5.conn.REConnectionHadoop.requestService	(	String	jsonData,
		String	url
	)		`[inline, static, protected]`

Definition at line 1865 of file REConnectionHadoop.java.

String [] roboearth.wp5.conn.REConnectionHadoop.searchActionRecipes	(	String	searchID,
		ArrayList< String >	outUIDs
	)		`[inline]`

Searches for action recipes whose uid starts with the given search string.

Parameters:

searchID any prefix of an uid

Returns:: an array of String objects containing OWL descriptions of the action recipes found

Implements roboearth.wp5.conn.REInterface.

Definition at line 1603 of file REConnectionHadoop.java.

String [] roboearth.wp5.conn.REConnectionHadoop.searchEnvironments	(	String	searchID,
		ArrayList< String >	outUIDs,
		ArrayList< ArrayList< String >>	outFilenames,
		ArrayList< ArrayList< String >>	outFileURLs
	)		`[inline]`

Searches for environments whose uid starts with the given search string.

Parameters:

searchID	any prefix of an uid
outFilenames	this list of lists will be used to return for every uid found the names of associated files. The first dimension's index corresponds to the index of the related owl description in the array that is returned by this method.
outFileURLs	this list of lists will be used to return for every uid found the URLs of associated files. The first dimension's index corresponds to the index of the related owl description in the array that is returned by this method.

Returns:: an array of String objects containing OWL descriptions of the environments found

Implements roboearth.wp5.conn.REInterface.

Definition at line 1645 of file REConnectionHadoop.java.

String [] roboearth.wp5.conn.REConnectionHadoop.searchObjects	(	String	searchID,
		ArrayList< String >	outUIDs,
		ArrayList< ArrayList< String >>	outFilenames,
		ArrayList< ArrayList< String >>	outFileURLs
	)		`[inline]`

Searches for object descriptions whose uid starts with the given search string.

Parameters:

searchID	any prefix of an uid
outUIDs	this list will be used to return the UIDs of all found objects
outFilenames	this list of lists will be used to return for every uid found the names of associated files. The first dimension's index corresponds to the index of the related owl description in the array that is returned by this method.
outFileURLs	this list of lists will be used to return for every uid found the URLs of associated files. The first dimension's index corresponds to the index of the related owl description in the array that is returned by this method.

Returns:: an array of String objects containing OWL descriptions of the objects found

Implements roboearth.wp5.conn.REInterface.

Definition at line 1715 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitActionRecipe	(	OWLOntology	actionRecipe,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits an action recipe to the RoboEarth DB.

Parameters:

actionRecipe	OWLOntology object containing the action recipe
cls	the class the action recipe belongs to
id	the action recipe's identifier
description	a natural language description of the recipe's functionality

Returns:: true - if submission was successfully completed
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 829 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitActionRecipe	(	String	actionRecipe,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits an action recipe to the RoboEarth DB.

Parameters:

actionRecipe	String containing the action recipe
cls	the class the action recipe belongs to
id	the action recipe's identifier
description	a natural language description of the recipe's functionality

Returns:: true - if submission was successfully completed
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 833 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitBinaryFile	(	String	url,
		InputStreamBody	isb
	)		`[inline, protected]`

Submits a binary file (related to the resource specified by the given URL) to the RoboEarth DB.

Parameters:

url	the URL of an DB entry, the binary file is related to
isb	the InputStreamBody containing the binary file

Returns:: true - if submission was successfully completed
false - otherwise

Definition at line 1152 of file REConnectionHadoop.java.

static boolean roboearth.wp5.conn.REConnectionHadoop.submitData	(	String	jsonData,
		String	submitURL
	)		`[inline, static, protected]`

Submits data to given URL via a HTTP Post request.

Parameters:

jsonData	JSON encoded data
submitURL	URL of RoboEarth DB to submit to

Returns:: true - if submission was successfully completed
false - otherwise

Definition at line 1208 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	OWLOntology	env,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits a description of an environment to the RoboEarth DB.

Parameters:

env	OWLOntology object containing the environment's description
cls	the class the environment belongs to
id	the environment's identifier
description	a natural language description of the environment

Returns:: true - if submission was successfully completed
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 860 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	String	env,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits a description of an environment to the RoboEarth DB.

Parameters:

env	String containing the environment's description
cls	the class the environment belongs to
id	the environment's identifier
description	a natural language description of the environment

Returns:: true - if submission was successfully completed
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 864 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	OWLOntology	map,
		String	cls,
		String	id,
		String	description,
		ArrayList< File >	binaryFiles
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 891 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	String	owlData,
		String	cls,
		String	id,
		String	description,
		ArrayList< File >	binaryFiles
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 897 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	OWLOntology	map,
		String	cls,
		String	id,
		String	description,
		ArrayList< byte[]>	binaryData,
		ArrayList< String >	filenames
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 919 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironment	(	String	owlData,
		String	cls,
		String	id,
		String	description,
		ArrayList< byte[]>	binaryData,
		ArrayList< String >	filenames
	)		`[inline]`

Implements roboearth.wp5.conn.REInterface.

Definition at line 925 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironmentBinaryFile	(	String	uid,
		final File	file
	)		`[inline]`

Definition at line 1088 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitEnvironmentBinaryFile	(	String	uid,
		final byte[]	data,
		String	filename
	)		`[inline]`

Definition at line 1119 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	OWLOntology	objectOwl,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits an object's description to the RoboEarth DB.

Parameters:

object_owl	OWLOntology object containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object

Returns:: true - if submission was successfully completed
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 947 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	String	objectOwl,
		String	cls,
		String	id,
		String	description
	)		`[inline]`

Submits an object's description to the RoboEarth DB.

Parameters:

object_owl	String containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object

Returns:: true - if submission was successfully completed
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 951 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	OWLOntology	objectOwl,
		String	cls,
		String	id,
		String	description,
		ArrayList< File >	binaryFiles
	)		`[inline]`

Submits an object's description to the RoboEarth DB. The given binary files, related to the object description, will be stored in the RoboEarthDB as well.

Parameters:

objectOwl	OWLOntology object containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object
binaryFiles	object related binary files

Returns:: true - if submission was successfully completed
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 977 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	String	objectOwl,
		String	cls,
		String	id,
		String	description,
		ArrayList< File >	binaryFiles
	)		`[inline]`

Submits an object's description to the RoboEarth DB. The given binary files, related to the object description, will be stored in the RoboEarthDB as well.

Parameters:

objectOwl	String containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object
binaryFiles	object related binary files

Returns:: true - if submission was successfully completed
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 982 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	OWLOntology	objectOwl,
		String	cls,
		String	id,
		String	description,
		ArrayList< byte[]>	binaryData,
		ArrayList< String >	filenames
	)		`[inline]`

Submits an object's description to the RoboEarth DB. The given binary data, related to the object description, will be stored in the RoboEarthDB as well.

Parameters:

objectOwl	OWLOntology object containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object
binaryData	the content of the files in byte arrays
filenames	the unique filenames (among all files related to the specified object)

Returns:: true - if submission was successfully completed
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 1004 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObject	(	String	objectOwl,
		String	cls,
		String	id,
		String	description,
		ArrayList< byte[]>	binaryData,
		ArrayList< String >	filenames
	)		`[inline]`

Submits an object's description to the RoboEarth DB. The given binary data, related to the object description, will be stored in the RoboEarthDB as well.

Parameters:

objectOwl	String containing the object's description
cls	the class the object belongs to
id	the object's identifier
description	a natural language description of the object
binaryData	the content of the files in byte arrays
filenames	the unique filenames (among all files related to the specified object)

Returns:: true - if submission was successfully completed
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1010 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObjectBinaryFile	(	String	uid,
		final File	file
	)		`[inline]`

Definition at line 1032 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.submitObjectBinaryFile	(	String	uid,
		final byte[]	data,
		String	filename
	)		`[inline]`

Definition at line 1063 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateActionRecipe	(	String	uid,
		OWLOntology	actionRecipe,
		String	description
	)		`[inline]`

Updates the action recipe specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the action recipe's unique identifier
actionRecipe	OWLOntology object containing the action recipe
description	a natural language description of the recipe's functionality

Returns:: true - if the recipe was successfully updated
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 1410 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateActionRecipe	(	String	uid,
		String	actionRecipe,
		String	description
	)		`[inline]`

Updates the action recipe specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the action recipe's unique identifier
actionRecipe	String containing the action recipe
description	a natural language description of the recipe's functionality

Returns:: true - if the recipe was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1414 of file REConnectionHadoop.java.

static boolean roboearth.wp5.conn.REConnectionHadoop.updateData	(	String	jsonData,
		String	updateURL
	)		`[inline, static, protected]`

Updates an entry of the RoboEarth DB with the given data via a HTTP Put request.

Parameters:

jsonData	JSON encoded data
updateURL	URL of RoboEarth DB entry to update

Returns:: true - if the DB entry was successfully updated
false - otherwise

Definition at line 1557 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateEnvironment	(	String	uid,
		OWLOntology	env,
		String	description
	)		`[inline]`

Updates the environment specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the environment's unique identifier
env	OWLOntology object containing the environment's description
description	a natural language description of the environment

Returns:: true - if the environment was successfully updated
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 1435 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateEnvironment	(	String	uid,
		String	env,
		String	description
	)		`[inline]`

Updates the environment specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the environment's unique identifier
env	String containing the environment's description
description	a natural language description of the environment

Returns:: true - if the environment was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1440 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateEnvironmentBinaryFile	(	String	uid,
		File	file
	)		`[inline]`

Updates (replaces) the specified environment related binary file with the given file.

Parameters:

uid	the environment's unique identifier

Returns:: true - if the file was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1463 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateEnvironmentBinaryFile	(	String	uid,
		byte[]	data,
		String	filename
	)		`[inline]`

Updates (replaces) the specified environment related binary file with the content of the given byte array.

Parameters:

uid	the environment's unique identifier
data	the content of the file in a byte array
filename	the unique filename (among all files related to the specified environment)

Returns:: true - if the file was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1477 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateObject	(	String	uid,
		OWLOntology	objectOwl,
		String	description
	)		`[inline]`

Updates the object specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the object's unique identifier
objectOwl	OWLOntology object containing the object's description
description	a natural language description of the object

Returns:: true - if the object was successfully updated
false - otherwise

Deprecated:: OWLOntology can change the OWL content, use the version with String parameter instead

Implements roboearth.wp5.conn.REInterface.

Definition at line 1491 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateObject	(	String	uid,
		String	objectOwl,
		String	description
	)		`[inline]`

Updates the object specified by the parameter uid with the given OWL and natural language descriptions.

Parameters:

uid	the object's unique identifier
objectOwl	String containing the object's description
description	a natural language description of the object

Returns:: true - if the object was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1496 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateObjectBinaryFile	(	String	uid,
		File	file
	)		`[inline]`

Updates (replaces) the specified object related binary file with the given file.

Parameters:

uid	the object's unique identifier

Returns:: true - if the file was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1522 of file REConnectionHadoop.java.

boolean roboearth.wp5.conn.REConnectionHadoop.updateObjectBinaryFile	(	String	uid,
		byte[]	data,
		String	filename
	)		`[inline]`

Updates (replaces) the specified object related binary file with the content of the given byte array.

Parameters:

uid	the object's unique identifier
data	the content of the file in a byte array
filename	the unique filename (among all files related to the specified object)

Returns:: true - if the file was successfully updated
false - otherwise

Implements roboearth.wp5.conn.REInterface.

Definition at line 1536 of file REConnectionHadoop.java.

Member Data Documentation

final String roboearth.wp5.conn.REConnectionHadoop.apiKey [private]

API key for the REST interface to the RoboEarth DB

Definition at line 126 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.fileIdObjArticModel = "articulationModel" [static, private]

Definition at line 213 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.fileIdObjImage = "image" [static, private]

Definition at line 209 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.fileIdObjModel = "model" [static, private]

Definition at line 211 of file REConnectionHadoop.java.

final JsonFormatter roboearth.wp5.conn.REConnectionHadoop.JSON_FORMATTER = new PrettyJsonFormatter() [static, private]

JSON formatter that creates string representations of JSON objects

Definition at line 201 of file REConnectionHadoop.java.

final JdomParser roboearth.wp5.conn.REConnectionHadoop.json_parser = new JdomParser() [static, private]

JSON parser used to extract data fields from HTTP responses from the RoboEarth DB

Definition at line 196 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.mapExtractorSuffix = "/api/service/3dto2dmap" [static]

URL suffix for requesting 2d map extraction from 3d octomaps

Definition at line 191 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.querySuffix = "/api/serql" [static]

URL suffix for querying the semantic DB

Definition at line 186 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestActionRecipeSuffix = "/api/recipe/" [static]

URL suffix for requesting an action recipe

Definition at line 136 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentBinariesSuffix = "/data/environments/" [static]

URL suffix for requesting binary files related to objects

Definition at line 156 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestEnvironmentSuffix = "/api/environment/" [static]

URL suffix for requesting an environment

Definition at line 141 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestObjectBinariesSuffix = "/data/objects/" [static]

URL suffix for requesting binary files related to objects

Definition at line 151 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestObjectSuffix = "/api/object/" [static]

URL suffix for requesting information about an object

Definition at line 131 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.requestRobotSuffix = "/api/robot/" [static]

URL suffix for requesting a robot

Definition at line 146 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.roboEarthBaseURL = "http://api.roboearth.org" [static]

Base URL to the RoboEarth web interface

Definition at line 121 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.submitActionRecipeSuffix = "/api/recipe" [static]

URL suffix for submitting an action recipe

Definition at line 166 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.submitEnvironmentBinariesSuffix = "/api/binary/environments/" [static]

URL suffix for submitting binary files related to environments

Definition at line 181 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.submitEnvironmentSuffix = "/api/environment" [static]

URL suffix for submitting an environment

Definition at line 171 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.submitObjectBinariesSuffix = "/api/binary/objects/" [static]

URL suffix for submitting binary files related to objects

Definition at line 176 of file REConnectionHadoop.java.

final String roboearth.wp5.conn.REConnectionHadoop.submitObjectSuffix = "/api/object" [static]

URL suffix for submitting information about an object

Definition at line 161 of file REConnectionHadoop.java.

final int roboearth.wp5.conn.REConnectionHadoop.timoutInMs = 60000 [static]

Connection timeout in milliseconds

Definition at line 206 of file REConnectionHadoop.java.

The documentation for this class was generated from the following file:

REConnectionHadoop.java

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation