mmLib.mmCIF.mmCIFTable

Package mmLib :: Module mmCIF :: Class mmCIFTable

[show private | hide private]

Type mmCIFTable

object --+    
         |    
      list --+
             |
            mmCIFTable

Contains columns and rows of data for a mmCIF section. Rows of data are stored as mmCIFRow classes.

Method Summary
	`__init__(self, name, columns)`
	`__deepcopy__(self, memo)`
	`__delitem__(self, i)`
	`__eq__(self, other)`
	`__getattr__(self, name)`
	`__getitem__(self, x)` Retrieves mmCIFRow at index x from the table if the argument is a integer.
	`__setitem__(self, x, value)`
	`append(self, row)`
	`append_column(self, column)` Appends a column(subsection) name to the table.
	`autoset_columns(self)` Automaticly sets the mmCITable column names by inspecting all mmCIFRow objects it contains.
	`get(self, x, default)`
	`get_row(self, *args)` Preforms a SQL-like 'AND' select aginst all the rows in the table, and returns the first matching row found.
	`get_row1(self, clower, value)` Return the first row which which has column data matching value.
	`has_column(self, column)` Tests if the table contains the column name.
	`insert(self, i, row)`
	`is_single(self)` Return true if the table is not a _loop table with multiple rows of data.
	`iter_rows(self, *args)` This is the same as get_row, but it iterates over all matching rows in the table.
	`new_row(self)`
	`remove(self, row)`
	`remove_column(self, column)` Removes the column name from the table.
	`row_index_dict(self, clower)` Return a dictionary mapping the value of the row's value in column 'key' to the row itself.
	`set_columns(self, columns)` Sets the list of of column(subsection) names to the list of names in columns.
Inherited from list
	`__add__(x, y)` x.__add__(y) <==> x+y
	`__contains__(x, y)` x.__contains__(y) <==> y in x
	`__delslice__(x, i, j)` Use of negative indices is not supported.
	`__ge__(x, y)` x.__ge__(y) <==> x>=y
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__getslice__(x, i, j)` Use of negative indices is not supported.
	`__gt__(x, y)` x.__gt__(y) <==> x>y
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__iadd__(x, y)` x.__iadd__(y) <==> x+=y
	`__imul__(x, y)` x.__imul__(y) <==> x*=y
	`__iter__(x)` x.__iter__() <==> iter(x)
	`__le__(x, y)` x.__le__(y) <==> x<=y
	`__len__(x)` x.__len__() <==> len(x)
	`__lt__(x, y)` x.__lt__(y) <==> x<y
	`__mul__(x, n)` x.__mul__(n) <==> x*n
	`__ne__(x, y)` x.__ne__(y) <==> x!=y
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__reversed__(...)` L.__reversed__() -- return a reverse iterator over the list
	`__rmul__(x, n)` x.__rmul__(n) <==> n*x
	`__setslice__(x, i, j, y)` Use of negative indices is not supported.
	`count(L, value)` L.count(value) -> integer -- return number of occurrences of value
	`extend(...)` L.extend(iterable) -- extend list by appending elements from the iterable
	`index(...)` L.index(value, [start, [stop]]) -> integer -- return first index of value
	`pop(L, index)` L.pop([index]) -> item -- remove and return item at index (default last)
	`reverse(...)` L.reverse() -- reverse IN PLACE
	`sort(...)` L.sort(cmp=None, key=None, reverse=False) -- stable sort IN PLACE; cmp(x, y) -> -1, 0, 1
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`list`	`__slots__` = `['name', 'columns', 'columns_lower', 'data']`
`member_descriptor`	`columns` = `<member 'columns' of 'mmCIFTable' objects>`
`member_descriptor`	`columns_lower` = `<member 'columns_lower' of 'mmCIFTable' ...`
`member_descriptor`	`data` = `<member 'data' of 'mmCIFTable' objects>`
`member_descriptor`	`name` = `<member 'name' of 'mmCIFTable' objects>`

Method Details

getitem(self, x)
(Indexing operator)

Retrieves mmCIFRow at index x from the table if the argument is a integer. If the argument is a string, then the data from the first row is returned.

Overrides:: __builtin__.list.__getitem__

append_column(self, column)

Appends a column(subsection) name to the table.

autoset_columns(self)

Automaticly sets the mmCITable column names by inspecting all mmCIFRow objects it contains.

get_row(self, *args)

Preforms a SQL-like 'AND' select aginst all the rows in the table,
and returns the first matching row found.  The arguments are a
variable list of tuples of the form:
  (<lower-case-column-name>, <column-value>)
For example:
  ger_row(('atom_id','CA'),('entity_id', '1'))
returns the first matching row with atom_id==1 and entity_id==1.

get_row1(self, clower, value)

Return the first row which which has column data matching value.

has_column(self, column)

Tests if the table contains the column name.

is_single(self)

Return true if the table is not a _loop table with multiple rows of data.

iter_rows(self, *args)

This is the same as get_row, but it iterates over all matching rows in the table.

remove_column(self, column)

Removes the column name from the table.

row_index_dict(self, clower)

Return a dictionary mapping the value of the row's value in column 'key' to the row itself. If there are multiple rows with the same key value, they will be overwritten with the last found row.

set_columns(self, columns)

Sets the list of of column(subsection) names to the list of names in columns.

Class Variable Details

slots

Type:: list
Value:: ['name', 'columns', 'columns_lower', 'data']

columns

Type:: member_descriptor
Value:: <member 'columns' of 'mmCIFTable' objects>

columns_lower

Type:: member_descriptor
Value:: <member 'columns_lower' of 'mmCIFTable' objects>

data

Type:: member_descriptor
Value:: <member 'data' of 'mmCIFTable' objects>

name

Type:: member_descriptor
Value:: <member 'name' of 'mmCIFTable' objects>

Generated by Epydoc 2.1 on Sun Apr 23 22:08:38 2006

http://epydoc.sf.net