python.data.DataSpecification.DataSpecification Class Reference

The class encapsulates the description of the data set, like names of dimensions and source file. More...

Inheritance diagram for python.data.DataSpecification.DataSpecification:

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	addAttribute (self, attributeName, attributeValue)
	Adds an attribute to the attribute collection. More...
def	cleanAttributes (self)
	Deletes all data from attributes collection. More...
def	createNumericAttributes (self, dim)
	Fills data specification with a number of numeric attributes with names x0, x1, x2... More...
def	generateFilename (self)
	Generates a new random file name. More...
def	getAttributes (self)
	Returns the collection of attributes stored in the specification. More...
def	getFilename (self)
	Returns the file name. More...
def	isSaved (self)
	Checks if the data set was already saved as a file. More...
def	setFilename (self, filename)
	Sets the file name. More...
def	setSaved (self)
	Marks the data set as saved. More...
def	toString (self)
	Returns a string that represents the object. More...

Static Public Attributes
	attributes = None
	Dictionary of attributes. More...
	filename = None
	The file name. More...

Detailed Description

The class encapsulates the description of the data set, like names of dimensions and source file.

Constructor & Destructor Documentation

__init__()

def python.data.DataSpecification.DataSpecification.__init__

(

self

)

Constructor.

References python.data.DataSpecification.DataSpecification.__isSaved, json::DictNode.attributes, python.data.DataSpecification.DataSpecification.attributes, python.controller.InfoToFile.InfoToFile.filename, python.data.DataSpecification.DataSpecification.filename, python.data.ARFFAdapter.ARFFAdapter.filename, and python.data.CSVAdapter.CSVAdapter.filename.

Member Function Documentation

addAttribute()

def python.data.DataSpecification.DataSpecification.addAttribute	(		self,
			attributeName,
			attributeValue
	)

Adds an attribute to the attribute collection.

Parameters

attributeName	attribute name
attributeValue	attribute value

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.createNumericAttributes().

cleanAttributes()

def python.data.DataSpecification.DataSpecification.cleanAttributes

(

self

)

Deletes all data from attributes collection.

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.createNumericAttributes().

createNumericAttributes()

def python.data.DataSpecification.DataSpecification.createNumericAttributes	(		self,
			dim
	)

Fills data specification with a number of numeric attributes with names x0, x1, x2...

Parameters

dim	the number of attributes

References json::DictNode.addAttribute(), python.data.DataSpecification.DataSpecification.addAttribute(), json::Node.addAttribute(), and python.data.DataSpecification.DataSpecification.cleanAttributes().

generateFilename()

def python.data.DataSpecification.DataSpecification.generateFilename

(

self

)

Generates a new random file name.

Returns

: new random file name

Referenced by python.data.DataSpecification.DataSpecification.getFilename().

getAttributes()

def python.data.DataSpecification.DataSpecification.getAttributes

(

self

)

Returns the collection of attributes stored in the specification.

Returns

: collection of attributes

References json::DictNode.attributes, and python.data.DataSpecification.DataSpecification.attributes.

Referenced by python.data.DataSpecification.DataSpecification.toString().

getFilename()

def python.data.DataSpecification.DataSpecification.getFilename

(

self

)

Returns the file name.

Returns

: the file name

References python.controller.InfoToFile.InfoToFile.filename, python.data.ARFFAdapter.ARFFAdapter.filename, python.data.DataSpecification.DataSpecification.filename, python.data.CSVAdapter.CSVAdapter.filename, python.data.DataSpecification.DataSpecification.generateFilename(), and python.data.DataSpecification.DataSpecification.setFilename().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), python.data.DataSpecification.DataSpecification.toString(), and python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

isSaved()

def python.data.DataSpecification.DataSpecification.isSaved

(

self

)

Checks if the data set was already saved as a file.

Returns

: True, if data set was saved, otherwise: False

References python.data.DataSpecification.DataSpecification.__isSaved.

setFilename()

def python.data.DataSpecification.DataSpecification.setFilename	(		self,
			filename
	)

Sets the file name.

Parameters

filename

new file name

References python.controller.InfoToFile.InfoToFile.filename, python.data.DataSpecification.DataSpecification.filename, python.data.ARFFAdapter.ARFFAdapter.filename, and python.data.CSVAdapter.CSVAdapter.filename.

Referenced by python.data.DataSpecification.DataSpecification.getFilename().

setSaved()

def python.data.DataSpecification.DataSpecification.setSaved

(

self

)

Marks the data set as saved.

References python.data.DataSpecification.DataSpecification.__isSaved.

toString()

def python.data.DataSpecification.DataSpecification.toString

(

self

)

Returns a string that represents the object.

Returns

A string that represents the object.

References python.data.DataSpecification.DataSpecification.getAttributes(), and python.data.DataSpecification.DataSpecification.getFilename().

Referenced by python.uq.learner.Learner.Learner.createMemento(), python.learner.Learner.Learner.createMemento(), and python.learner.formatter.GridFormatter.GridFormatter.serialize().

Member Data Documentation

attributes

python.data.DataSpecification.DataSpecification.attributes = None

static

Dictionary of attributes.

Referenced by python.data.DataSpecification.DataSpecification.__init__(), python.data.DataSpecification.DataSpecification.addAttribute(), python.data.DataSpecification.DataSpecification.cleanAttributes(), and python.data.DataSpecification.DataSpecification.getAttributes().

filename

python.data.DataSpecification.DataSpecification.filename = None

static

The file name.

Referenced by python.data.DataSpecification.DataSpecification.__init__(), python.data.DataSpecification.DataSpecification.getFilename(), and python.data.DataSpecification.DataSpecification.setFilename().

---

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

• datadriven/python/data/DataSpecification.py