acme.etc.Types.FilterCriteria

class documentation

class FilterCriteria:

View In Hierarchy

Sub-structure for CSERequest.

It contains the filterCriteria attributes and further helper attributes.

Method __str__ String representation of the Filter Criteria attributes.
Method criteriaAttributes Return all the set Filter Criteria attributes, ie. that are not None. The result doesn't include handling attributes, such as 'fu','lim' or 'fo' etc.
Method fillCriteriaAttributes Create and return a dictionary with all (unfiltered) Filter Criteria attributes.
Method mapAttributes Map the standard and attribute Filter Criteria attributes.
Method set Set a Filter Criteria attribute by it's name. If it is not a predefined attribute, then add it to the attributes attrribute.
Class Variable aq Advanced query. Default is None.
Class Variable arp applyRelativePath. Default is None.
Class Variable attributes All other remaining filter resource attributes.
Class Variable catr Child attribute. Default is None.
Class Variable cra Created after. Default is None.
Class Variable crb Created before. Default is None.
Class Variable cty List of content types. Default is None.
Class Variable exa Expire after. Default is None.
Class Variable exb Expire before. Default is None.
Class Variable fo Filter Operation. Default is AND.
Class Variable fu conditional retrieval.
Class Variable geom geometry for geo-query. Default is None.
Class Variable gmty geometryType for geo-query. Default is None.
Class Variable gsf geoSpatialFunction for geo-query. Default is None.
Class Variable lbl List of labels. Default is None.
Class Variable lbq Labels query. Default is None.
Class Variable lim Limit filter criterion. Default is sys.maxsize.
Class Variable lvl Level filter criterion. Default is sys.maxsize.
Class Variable ms Modified since. Default is None.
Class Variable ofst Offset filter criterion. Default is 1.
Class Variable patr Parent attribute. Dfault is None.
Class Variable smf Semantic filter. Default is None.
Class Variable stb State tag bigger. Default is None.
Class Variable sts State tag smaller. Default is None.
Class Variable sza Size above. Default is None.
Class Variable szb Size before. Default is None.
Class Variable ty List of resource types. Default is None.
Class Variable us Unmodified since. Default is us.
Class Variable _geom Internal attribute to hold a parsed geometry. Default is None.
def __str__(self) -> str:

String representation of the Filter Criteria attributes.

Returns
strString representation.
def criteriaAttributes(self) -> dict:

Return all the set Filter Criteria attributes, ie. that are not None. The result doesn't include handling attributes, such as 'fu','lim' or 'fo' etc.

Returns
dictDictionary with set Filter Criteria attributes.
def fillCriteriaAttributes(self) -> dict:

Create and return a dictionary with all (unfiltered) Filter Criteria attributes.

Returns
dictDictionary with all attributes.
def mapAttributes(self, cb: Callable, flattenList: bool):

Map the standard and attribute Filter Criteria attributes.

This method calls a callback or lambda function that can map the keys and attributes further.

Parameters
cb:CallableCallback function that receives a key and its value.
flattenList:boolSeparate a list in multiple values or keep the list
def set(self, name: str, value: Any):

Set a Filter Criteria attribute by it's name. If it is not a predefined attribute, then add it to the attributes attrribute.

Parameters
name:strName of the attribute.
value:AnyValue of the attribute.
aq: str =

Advanced query. Default is None.

arp: str =

applyRelativePath. Default is None.

attributes: Parameters =

All other remaining filter resource attributes.

catr: str =

Child attribute. Default is None.

cra: str =

Created after. Default is None.

crb: str =

Created before. Default is None.

cty: list =

List of content types. Default is None.

exa: str =

Expire after. Default is None.

exb: str =

Expire before. Default is None.

fo: FilterOperation =

Filter Operation. Default is AND.

fu: FilterUsage =

conditional retrieval.

geom: str =

geometry for geo-query. Default is None.

gmty: GeometryType =

geometryType for geo-query. Default is None.

gsf: GeoSpatialFunctionType =

geoSpatialFunction for geo-query. Default is None.

lbl: list =

List of labels. Default is None.

lbq: str =

Labels query. Default is None.

lim: int =

Limit filter criterion. Default is sys.maxsize.

lvl: int =

Level filter criterion. Default is sys.maxsize.

ms: str =

Modified since. Default is None.

ofst: int =

Offset filter criterion. Default is 1.

patr: str =

Parent attribute. Dfault is None.

smf: str =

Semantic filter. Default is None.

stb: int =

State tag bigger. Default is None.

sts: int =

State tag smaller. Default is None.

sza: int =

Size above. Default is None.

szb: int =

Size before. Default is None.

ty: list =

List of resource types. Default is None.

us: str =

Unmodified since. Default is us.

_geom: list =

Internal attribute to hold a parsed geometry. Default is None.