Back to index

plone3  3.1.7
Public Member Functions
Archetypes.interfaces._schema.ISchemata Class Reference
Inheritance diagram for Archetypes.interfaces._schema.ISchemata:
Inheritance graph
[legend]
Collaboration diagram for Archetypes.interfaces._schema.ISchemata:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getName
def __add__
def copy
def fields
def widgets
def filterFields
def __setitem__
def addField
def updateField
def __delitem__
def delField
def __getitem__
def get
def has_key
def keys
def searchable

Detailed Description

Schemata (roughly) represents a group of fields

Definition at line 3 of file _schema.py.


Member Function Documentation

Add two schematas

Definition at line 9 of file _schema.py.

00009 
00010     def __add__(other):
00011         """Add two schematas"""

Delete field by name ``name`` 

Definition at line 49 of file _schema.py.

00049 
00050     def __delitem__(name):
00051         """Delete field by name ``name`` """

Get field by name.

Raises KeyError if the field does not exist.

Definition at line 55 of file _schema.py.

00055 
00056     def __getitem__(name):
00057         """Get field by name.
00058 
00059         Raises KeyError if the field does not exist.
00060         """

Here is the caller graph for this function:

Add a field under key ``name`` (possibly
overriding an existing one)

Definition at line 38 of file _schema.py.

00038 
00039     def __setitem__(name, field):
00040         """Add a field under key ``name`` (possibly
00041         overriding an existing one)
00042         """

Here is the caller graph for this function:

Add a field (possibly overriding an existing one)

Definition at line 43 of file _schema.py.

00043 
00044     def addField(field):
00045         """Add a field (possibly overriding an existing one)"""

Here is the caller graph for this function:

Return a deep copy

Definition at line 12 of file _schema.py.

00012 
00013     def copy():
00014         """Return a deep copy"""

Here is the caller graph for this function:

Delete field by name ``name`` 

Definition at line 52 of file _schema.py.

00052 
00053     def delField(name):
00054         """Delete field by name ``name`` """

Return a list of fields

Definition at line 15 of file _schema.py.

00015 
00016     def fields():
00017         """Return a list of fields"""

Here is the caller graph for this function:

def Archetypes.interfaces._schema.ISchemata.filterFields (   predicates,
  values 
)
Returns a subset of self.fields(), containing only fields that
satisfy the given conditions.

You can either specify predicates or values or both. If you provide
both, all conditions must be satisfied.

For each ``predicate`` (positional argument), ``predicate(field)`` must
return 1 for a Field ``field`` to be returned as part of the result.

Each ``attr=val`` function argument defines an additional predicate:
A field must have the attribute ``attr`` and field.attr must be equal
to value ``val`` for it to be in the returned list.

Definition at line 23 of file _schema.py.

00023 
00024     def filterFields(*predicates, **values):
00025         """Returns a subset of self.fields(), containing only fields that
00026         satisfy the given conditions.
00027 
00028         You can either specify predicates or values or both. If you provide
00029         both, all conditions must be satisfied.
00030 
00031         For each ``predicate`` (positional argument), ``predicate(field)`` must
00032         return 1 for a Field ``field`` to be returned as part of the result.
00033 
00034         Each ``attr=val`` function argument defines an additional predicate:
00035         A field must have the attribute ``attr`` and field.attr must be equal
00036         to value ``val`` for it to be in the returned list.
00037         """

Here is the caller graph for this function:

def Archetypes.interfaces._schema.ISchemata.get (   name,
  default = None 
)
Get field by name, using a default value
for missing

Definition at line 61 of file _schema.py.

00061 
00062     def get(name, default=None):
00063         """Get field by name, using a default value
00064         for missing
00065         """

Here is the caller graph for this function:

Return Schemata name

Definition at line 6 of file _schema.py.

00006 
00007     def getName():
00008         """Return Schemata name"""

Here is the caller graph for this function:

Check if a field by the given name exists

Definition at line 66 of file _schema.py.

00066 
00067     def has_key(name):
00068         """Check if a field by the given name exists"""

Here is the caller graph for this function:

Return the names of the fields present
on this schema

Definition at line 69 of file _schema.py.

00069 
00070     def keys():
00071         """Return the names of the fields present
00072         on this schema"""

Here is the caller graph for this function:

Return a list containing names of all
the fields present on this schema that are
searchable.

Definition at line 73 of file _schema.py.

00073 
00074     def searchable():
00075         """Return a list containing names of all
00076         the fields present on this schema that are
00077         searchable.
00078         """

Update a field (possibly overriding an existing one)

Definition at line 46 of file _schema.py.

00046 
00047     def updateField(field):
00048         """Update a field (possibly overriding an existing one)"""

Return a dictionary that contains a widget for
each field, using the field name as key

Definition at line 18 of file _schema.py.

00018 
00019     def widgets():
00020         """Return a dictionary that contains a widget for
00021         each field, using the field name as key
00022         """

Here is the caller graph for this function:


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