JsonBlob.JsonBlob Class Reference

Json File Abstraction. More...

Inheritance diagram for JsonBlob.JsonBlob:

Public Member Functions
def	__init__ (self, index=None, autoload=True)
def	reload (self)
def	save (self)
def	delete (self)
def	blobExists (self)
def	getModulePath (self)
def	getTypePath (self)
def	getRowPath (self)
def	getRowFileName (self)

Static Public Member Functions
def	reindex (force=False)
def	find (jbModule, jbType, jbIndex)
def	all (jbModule=None, jbType=None)
def	hydrate (jbModule=None, jbType=None, ids=[])

Public Attributes
	jbModule
	jbType
	jbIndex
	jsonData

Static Public Attributes
	basepath = os.path.join(AmsEnvironment.FilePath(), 'jsonblob')
	indexpath = os.path.join(basepath, 'index.json')
dictionary	constructors = {}
bool	indexexists = False
bool	indexed = False
dictionary	index = {}

Detailed Description

Json File Abstraction.

Constructor & Destructor Documentation

__init__()

def JsonBlob.JsonBlob.__init__	(		self,
			index = None,
			autoload = True
	)

configures JsonBlob settings and loads any saved data for this jbIndex

@param index
@param autoload

Member Function Documentation

all()

def JsonBlob.JsonBlob.all (   jbModule = None,   jbType = None  )

static

returns a dict of saved objects (keyed by jbIndex) or empty dict

@param jbModule
@param jbType

@return dict

blobExists()

def JsonBlob.JsonBlob.blobExists

(

self

)

checks whether saved data exists for this object

@return bool

delete()

def JsonBlob.JsonBlob.delete

(

self

)

deletes any saved data

find()

def JsonBlob.JsonBlob.find (   jbModule,   jbType,   jbIndex  )

static

returns the saved data or an empty dict

@param jbModule
@param jbType
@param jbIndex

@return dict

getModulePath()

def JsonBlob.JsonBlob.getModulePath

(

self

)

returns the full file path for the module directory

@return str

getRowFileName()

def JsonBlob.JsonBlob.getRowFileName

(

self

)

returns the file name for the object

@return str

getRowPath()

def JsonBlob.JsonBlob.getRowPath

(

self

)

returns the full file path for the object data

@return str

getTypePath()

def JsonBlob.JsonBlob.getTypePath

(

self

)

returns the full file path for the type directory

@return str

hydrate()

def JsonBlob.JsonBlob.hydrate (   jbModule = None,   jbType = None,   ids = []  )

static

builds a dict of instantiated objects

@param jbModule
@param jbType
@param ids

@return dict

reindex()

def JsonBlob.JsonBlob.reindex (   force = False )

static

collects information about available blobs from the file system

@param force

reload()

def JsonBlob.JsonBlob.reload

(

self

)

reinitializes the jsonData

save()

def JsonBlob.JsonBlob.save

(

self

)

saves the current jsonData

---

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

• JsonBlob.py