mark.core

Class DataAgentProfile

java.lang.Object

mark.core.DataAgentProfile

public class DataAgentProfile
extends Object

Author:

Thibault Debatty

Field Summary

Fields

Modifier and Type	Field and Description
String	class_name Name of the class to instantiate (must implement DataAgentInterface).
String	label The label for the data that will be added to the datastore.
Map<String,String>	parameters Additional parameters to pass to the agent (e.g time range).
File	path The path to the profile file, can be used to compute relative paths.

Constructor Summary

Constructors

Constructor and Description
DataAgentProfile()

Method Summary

Modifier and Type	Method and Description
DataAgentInterface	createInstance() Create an instance of this data agent.
static DataAgentProfile	fromFile(File file) Parse YAML configuration file to create data agent profile.
static DataAgentProfile	fromInputStream(InputStream input) Create profile from input stream (for example a resource file in jar).
File	getPath(String filename) Compute the File corresponding to this filename, which can be an absolute path, or a relative path to this data agent profile file.

Methods inherited from class java.lang.Object

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

Field Detail

class_name

public String class_name

Name of the class to instantiate (must implement DataAgentInterface).

label

public String label

The label for the data that will be added to the datastore.

parameters

public Map<String,String> parameters

Additional parameters to pass to the agent (e.g time range).

path

public File path

The path to the profile file, can be used to compute relative paths.

Constructor Detail

DataAgentProfile

public DataAgentProfile()

Method Detail

fromFile

public static final DataAgentProfile fromFile(File file)
                                       throws FileNotFoundException

Parse YAML configuration file to create data agent profile.

Parameters:

file -

Returns:

Throws:

FileNotFoundException - if the config file does not exist

fromInputStream

public static final DataAgentProfile fromInputStream(InputStream input)

Create profile from input stream (for example a resource file in jar).

Parameters:

input -

Returns:

createInstance

public final DataAgentInterface createInstance()
                                        throws InvalidProfileException

Create an instance of this data agent.

Returns:

Throws:

InvalidProfileException

getPath

public final File getPath(String filename)
                   throws FileNotFoundException

Compute the File corresponding to this filename, which can be an absolute path, or a relative path to this data agent profile file.

Parameters:

filename -

Returns:

Throws:

FileNotFoundException