medmodels.medrecord.querying#

Query API for MedRecord.

Classes

`AttributesTreeOperand`()	Query API for all attributes of given nodes/edges.
`EdgeDirection`(value[, names, module, ...])	Enumeration of edge directions.
`EdgeIndexOperand`()	A class representing an edge index operand.
`EdgeIndicesOperand`()	Query API for edge indices in a MedRecord.
`EdgeOperand`()	Query API for edges in a MedRecord.
`MultipleAttributesOperand`()	Query API for multiple attributes accross nodes/edges.
`MultipleValuesOperand`()	Query API for multiple attribute values in a MedRecord.
`NodeIndexOperand`()	Query API for a node index in a MedRecord.
`NodeIndicesOperand`()	Query API for node indices in a MedRecord.
`NodeOperand`()	Query API for nodes in a MedRecord.
`SingleAttributeOperand`()	Query API for a single attribute name in a MedRecord.
`SingleValueOperand`()	Query API for a single value in a MedRecord.

class AttributesTreeOperand[source]#

Bases: object

Query API for all attributes of given nodes/edges.

This operand is used to query on attribute names, not its values.

absolute()[source]#

Get the absolute value of the attribute names.

Return type:: None

add(attribute)[source]#

Add a value to all attribute names for each node/edge.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to add to all attribute names of each node/edge.
Return type:: None

clone()[source]#

Create a deep clone of the current attributes tree query.

Return type:: AttributesTreeOperand
Returns:: AttributesTreeOperand – A deep clone of the current attributes tree query.

contains(attribute)[source]#

Query which attribute names contain a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

count()[source]#

Query the number of attributes for each node/edge.

Return type:: MultipleAttributesOperand
Returns:: MultipleAttributesOperand – The number of attributes for each node/edge.

either_or(either, or_)[source]#

Apply either-or query logic to the current attributes tree.

This method evaluates two queries on the attributes tree and returns all attribute names that satisfy either the first query or the second query for each node/edge.

Parameters:

either (Callable[[AttributesTreeOperand], None]) – A query function to evaluate one condition on the attributes.
or (Callable[[AttributesTreeOperand], None]) – A query function to evaluate the alternative condition on the attributes.

Return type:

None

Example

Example usage of either_or logic to filter attributes

attributes_tree_operand.either_or(
    lambda attributes: attributes.is_int(),  # Query for integer attributes
    lambda attributes: attributes.is_float(),  # Query for float attributes
)

ends_with(attribute)[source]#

Query which attribute names end with a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

equal_to(attribute)[source]#

Query which attribute names are equal to a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

exclude(query)[source]#

Exclude attribute names based on the query.

Exclude attribute names that satisfy the query from the attributes tree.

Parameters:: query (Callable[[AttributesTreeOperand], None]) – The query to apply to exclude attribute names.
Return type:: None

first()[source]#

Query the first attribute of each node/edge.

Return type:: MultipleAttributesOperand
Returns:: MultipleAttributesOperand – The first attribute names for each node/edge.

greater_than(attribute)[source]#

Query which attribute names are greater than a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

greater_than_or_equal_to(attribute)[source]#

Query which attribute names are greater than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

is_in(attributes)[source]#

Query which attribute names are in a list of values for each node/edge.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The list of values to compare against across the attribute names of each node/edge.
Return type:: None

is_int()[source]#

Query which attribute names are integers for each node/edge.

Return type:: None

is_max()[source]#

Query which attribute names are the maximum value for each node/edge.

Return type:: None

is_min()[source]#

Query which attribute names are the minimum value for each node/edge.

Return type:: None

is_not_in(attributes)[source]#

Query which attribute names are not in a list of values for each node/edge.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The list of values to compare against across the attribute names of each node/edge.
Return type:: None

is_string()[source]#

Query which attribute names are strings for each node/edge.

Return type:: None

last()[source]#

Query the last attribute of each node/edge.

Return type:: MultipleAttributesOperand
Returns:: MultipleAttributesOperand – The first attribute names for each node/edge.

less_than(attribute)[source]#

Query which attribute names are less than a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

less_than_or_equal_to(attribute)[source]#

Query which attribute names are less than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

lowercase()[source]#

Convert the attribute names to lowercase.

Return type:: None

max()[source]#

Query the attributes which names have the maximum value for each node/edge.

Return type:

MultipleAttributesOperand

Returns:

MultipleAttributesOperand –

The attribute name with the maximum value for: each node/edge.

min()[source]#

Query the attributes which names have the minimum value for each node/edge.

Return type:

MultipleAttributesOperand

Returns:

MultipleAttributesOperand –

The attribute name with the minimum value for: each node/edge.

modulo(attribute)[source]#

Compute the modulo of the attribute names for each node/ edge by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to divide by when computing the modulo.
Return type:: None

multiply(attribute)[source]#

Multiply all attribute names for each node/edge by a value.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(attribute)[source]#

Query which attribute names are not equal to a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

power(attribute)[source]#

Raise the attribute names to a power for each node/edge.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The power to raise the attribute names to.
Return type:: None

slice(start, end)[source]#

Slice the attribute names.

The slice method extracts a section of the attribute names.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

starts_with(attribute)[source]#

Query which attribute names start with a value for each node/edge.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across all attribute names of each node/edge.
Return type:: None

subtract(attribute)[source]#

Subtract a value from all attribute names for each node/edge.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to subtract from all attribute names of each node/edge.
Return type:: None

sum()[source]#

Query the sum of the attributes for each node/edge.

Return type:: MultipleAttributesOperand
Returns:: MultipleAttributesOperand – The sum of the attributes for each node/edge.

trim()[source]#

Trim the attribute names for each node/edge.

The trim method removes leading and trailing whitespace from the attribute names.

Return type:: None

trim_end()[source]#

Trim the end of the attribute names for each node/edge.

The trim_end method removes trailing whitespace from the attribute names.

Return type:: None

trim_start()[source]#

Trim the start of the attribute names for each node/edge.

The trim_start method removes leading whitespace from the attribute names.

Return type:: None

uppercase()[source]#

Convert the attribute names to uppercase.

Return type:: None

class EdgeDirection(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

Enumeration of edge directions.

BOTH = 2#

INCOMING = 0#

OUTGOING = 1#

classmethod __contains__(value)#

Return True if value is in cls.

value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members.

classmethod __getitem__(name)#: Return the member matching name.

classmethod __iter__()#: Return members in definition order.

classmethod __len__()#: Return the number of members (no aliases)

class EdgeIndexOperand[source]#

Bases: object

A class representing an edge index operand.

An edge index operand is used to query edge indices in the graph database.

add(index)[source]#

Add the given index to the current edge index.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to add.
Return type:: None

clone()[source]#

Clone the current edge index operand so that it can be reused.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The cloned edge index operand.

contains(index)[source]#

Query the edge indices that contain the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

either_or(either, or_)[source]#

Apply either-or logic to the current edge index operand.

This method evaluates two queries on the edge index and returns the edge index that satisfies either the first query or the second query.

Parameters:

either (Callable[[EdgeIndexOperand], None]) – One of the queries to apply.
or (Callable[[EdgeIndexOperand], None]) – The other query to apply.

Return type:

None

Example

edge_index_operand.either_or(
    lambda edge_index: edge_index.contains(1),
    lambda edge_index: edge_index.less_than(10),
)

ends_with(index)[source]#

Query the edge indices that end with the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

equal_to(index)[source]#

Query the edge indices that are equal to the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

exclude(query)[source]#

Exclude the edge indices that meet the given query.

Parameters:: query (Callable[[EdgeIndexOperand], None]) – The query to exclude.
Return type:: None

greater_than(index)[source]#

Query the edge indices that are greater than the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

greater_than_or_equal_to(index)[source]#

Query the edge indices that are greater than or equal to the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

is_in(indices)[source]#

Query the edge indices that are in the given indices list.

Parameters:: indices (EdgeIndicesComparisonOperand) – The indices to compare with.
Return type:: None

is_not_in(indices)[source]#

Query the edge indices that are not in the given indices sequence.

Parameters:: indices (EdgeIndicesComparisonOperand) – The indices to compare with.
Return type:: None

less_than(index)[source]#

Query the edge indices that are less than the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

less_than_or_equal_to(index)[source]#

Query the edge indices that are less than or equal to the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

modulo(index)[source]#

Compute the modulo of the current edge index by the given index.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to divide by when computing the modulo.
Return type:: None

multiply(index)[source]#

Multiply the current edge index by the given index.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to multiply by.
Return type:: None

not_equal_to(index)[source]#

Query the edge indices that are not equal to the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

power(index)[source]#

Raise the current edge index to the power of the given index.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to raise to the power of.
Return type:: None

starts_with(index)[source]#

Query the edge indices that start with the given index.

Parameters:: index (EdgeIndexComparisonOperand) – The index to compare with.
Return type:: None

subtract(index)[source]#

Subtract the given index from the current edge index.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to subtract.
Return type:: None

class EdgeIndicesOperand[source]#

Bases: object

Query API for edge indices in a MedRecord.

add(index)[source]#

Add a value to the edge indices.

Parameters:: index (EdgeIndexArithmeticOperand) – The value to add.
Return type:: None

clone()[source]#

Create a deep clone of the current edge indices operand.

Return type:: EdgeIndicesOperand
Returns:: EdgeIndicesOperand – The cloned edge indices operand.

contains(index)[source]#

Query which edge indices contain a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

count()[source]#

Queries and returns the number of edge indices.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The number of edge indices.

either_or(either, or_)[source]#

Apply either-or logic to the edge indices.

This method evaluates two queries on the edge indices and returns the edge indices that satisfy either the first query or the second query.

Parameters:

either (Callable[[EdgeIndexOperand], None]) – One of the queries to apply.
or (Callable[[EdgeIndexOperand], None]) – The other query to apply.

Return type:

None

Example

edge_indices_operand.either_or(
    lambda edge_indices: edge_indices.contains(1),
    lambda edge_indices: edge_indices.less_than(10),
)

ends_with(index)[source]#

Query which edge indices end with a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

equal_to(index)[source]#

Query which edge indices are equal to a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude the edge indices that satisfy the given query.

Parameters:: query (Callable[[EdgeIndicesOperand], None]) – The query to exclude.
Return type:: None

first()[source]#

Queries and returns the first edge index.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The first edge index.

greater_than(index)[source]#

Query which edge indices are greater than a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(index)[source]#

Query which edge indices are greater than or equal to a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

is_in(indices)[source]#

Query which edge indices are in a list of values.

Parameters:: indices (EdgeIndicesComparisonOperand) – The values to compare against.
Return type:: None

is_not_in(indices)[source]#

Query which edge indices are not in a list of values.

Parameters:: indices (EdgeIndicesComparisonOperand) – The values to compare against.
Return type:: None

last()[source]#

Queries and returns the last edge index.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The last edge index.

less_than(index)[source]#

Query which edge indices are less than a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(index)[source]#

Query which edge indices are less than or equal to a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

max()[source]#

Queries and returns the edge index operand with the maximum value.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The edge index operand with the maximum value.

min()[source]#

Queries and returns the edge index operand with the minimum value.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The edge index operand with the minimum value.

modulo(index)[source]#

Compute the modulo of the edge indices by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: index (EdgeIndexArithmeticOperand) – The index to divide by when computing the modulo.
Return type:: None

multiply(index)[source]#

Multiply the edge indices by a value.

Parameters:: index (EdgeIndexArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(index)[source]#

Query which edge indices are not equal to a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

power(index)[source]#

Raise the edge indices to a power.

Parameters:: index (EdgeIndexArithmeticOperand) – The power to raise the edge indices to.
Return type:: None

starts_with(index)[source]#

Query which edge indices start with a value.

Parameters:: index (EdgeIndexComparisonOperand) – The value to compare against.
Return type:: None

subtract(index)[source]#

Subtract a value from the edge indices.

Parameters:: index (EdgeIndexArithmeticOperand) – The value to subtract.
Return type:: None

sum()[source]#

Queries and returns the sum of the edge indices.

Return type:: EdgeIndexOperand
Returns:: EdgeIndexOperand – The sum of the edge indices.

class EdgeOperand[source]#

Bases: object

Query API for edges in a MedRecord.

attribute(attribute)[source]#

Returns an operand representing the values of that attribute for the edges.

Parameters:

attribute (MedRecordAttribute) – The attribute to query.

Return type:

MultipleValuesOperand

Returns:

MultipleValuesOperand –

The operand representing the values of the attribute: for the edges in the current edge query.

attributes()[source]#

Returns an operand representing all the attributes of the edges queried.

Return type:

AttributesTreeOperand

Returns:

AttributesTreeOperand –

The operand representing all the attributes of the: edges in the current edge query.

clone()[source]#

Create a deep clone of the current edge query.

Return type:: EdgeOperand
Returns:: EdgeOperand – A deep clone of the current edge query.

either_or(either, or_)[source]#

Apply either-or logic to the current edge query.

This method applies the combination of the two queries to the edge query. It returns all edges that satisfy either the first query or the second query.

Parameters:

either (Callable[[EdgeIndexOperand], None]) – One of the queries to apply.
or (Callable[[EdgeIndexOperand], None]) – The other query to apply.

Return type:

None

Example

edge_operand.either_or(
    lambda edge: edge.source_node().in_group("group1"),
    lambda edge: edge.target_node().in_group("group1"),
)

exclude(query)[source]#

Exclude edges based on the query.

Parameters:: query (Callable[[EdgeIndexOperand], None]) – The query to apply to exclude edges.
Return type:: None

has_attribute(attribute)[source]#

Queries the edges that have all the attributes specified.

Parameters:: attribute (Union[MedRecordAttribute, List[MedRecordAttribute]]) – The attribute or attributes to check for.
Return type:: None

in_group(group)[source]#

Queries the edges that are in all the groups specified.

Parameters:: group (Union[Group, List[Group]]) – The group or groups to query.
Return type:: None

index()[source]#

Returns an operand representing the indices of the edges queried.

Return type:

EdgeIndicesOperand

Returns:

EdgeIndicesOperand –

The operand representing the indices of the edges in the: current edge query.

source_node()[source]#

Get the source node of the edges in an operand to query.

Return type:: NodeOperand
Returns:: NodeOperand – The operand to query the source node of the edges.

target_node()[source]#

Get the target node of the edges in an operand to query.

Return type:: NodeOperand
Returns:: NodeOperand – The operand to query the target node of the edges.

class MultipleAttributesOperand[source]#

Bases: object

Query API for multiple attributes accross nodes/edges.

This operand is used to query on multiple attributes names, not their values.

absolute()[source]#

Get the absolute value of the attribute names.

Return type:: None

add(attribute)[source]#

Add a value to the attribute names.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to add to the attribute names.
Return type:: None

clone()[source]#

Create a deep clone of the current multiple attributes query.

Return type:

MultipleAttributesOperand

Returns:

MultipleAttributesOperand –

A deep clone of the current multiple attributes: query.

contains(attribute)[source]#

Query which attribute names contain a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

count()[source]#

Query the number of attribute names across nodes/edges.

Return type:

SingleAttributeOperand

Returns:

SingleAttributeOperand –

The number of attribute names across all: nodes/edges.

either_or(either, or_)[source]#

Apply either-or query logic to the current multiple attributes query.

This method evaluates two queries on the multiple attributes and returns all attribute names that satisfy either the first query or the second query.

Parameters:

either (Callable[[MultipleAttributesOperand], None]) – A query function to evaluate one condition on the multiple attributes.
or (Callable[[MultipleAttributesOperand], None]) – A query function to evaluate the alternative condition on the multiple attributes.

Return type:

None

Example

Example usage of either_or logic to filter attributes

multiple_attributes_operand.either_or(
    lambda attributes: attributes.is_int(),  # Query for integer attributes
    lambda attributes: attributes.is_float(),  # Query for float attributes
)

ends_with(attribute)[source]#

Query which attribute names end with a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

equal_to(attribute)[source]#

Query which attribute names are equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

exclude(query)[source]#

Exclude attribute names based on the query.

Exclude attribute names that satisfy the query from the multiple attributes.

Parameters:: query (Callable[[MultipleAttributesOperand], None]) – The query to apply to exclude attribute names.
Return type:: None

first()[source]#

Query the first attribute name across nodes/edges.

Return type:: SingleAttributeOperand
Returns:: SingleAttributeOperand – The first attribute name across all nodes/edges.

greater_than(attribute)[source]#

Query which attribute names are greater than a value across nodes/edges.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

greater_than_or_equal_to(attribute)[source]#

Query which attribute names are greater than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

is_in(attributes)[source]#

Query which attribute names are in a list of values.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The list of values to compare against across the attribute names.
Return type:: None

is_int()[source]#

Query which attribute names are integers across nodes/edges.

Return type:: None

is_max()[source]#

Query which attribute names are the maximum value across nodes/edges.

Return type:: None

is_min()[source]#

Query which attribute names are the minimum value across nodes/edges.

Return type:: None

is_not_in(attributes)[source]#

Query which attribute names are not in a list of values.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The list of values to compare against across the attribute names.
Return type:: None

is_string()[source]#

Query which attribute names are strings across nodes/edges.

Return type:: None

last()[source]#

Query the last attribute name across nodes/edges.

Return type:: SingleAttributeOperand
Returns:: SingleAttributeOperand – The last attribute name across all nodes/edges.

less_than(attribute)[source]#

Query which attribute names are less than a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

less_than_or_equal_to(attribute)[source]#

Query which attribute names are less than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

lowercase()[source]#

Convert the attribute names to lowercase.

Return type:: None

max()[source]#

Query the attribute name across nodes/edges with the maximum value.

Return type:

SingleAttributeOperand

Returns:

SingleAttributeOperand –

The maximum attribute name across all: nodes/edges.

min()[source]#

Query the attribute name across nodes/edges with the minimum value.

Return type:

SingleAttributeOperand

Returns:

SingleAttributeOperand –

The minimum attribute name across all: nodes/edges.

modulo(attribute)[source]#

Compute the modulo of the attribute names by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to divide by when computing the modulo.
Return type:: None

multiply(attribute)[source]#

Multiply the attribute names by a value.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(attribute)[source]#

Query which attribute names are not equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

power(attribute)[source]#

Raise the attribute names to a power.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The power to raise the attribute names to.
Return type:: None

slice(start, end)[source]#

Slice the attribute names.

The slice method extracts a section of the attribute names.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

starts_with(attribute)[source]#

Query which attribute names start with a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against across the attribute names.
Return type:: None

subtract(attribute)[source]#

Subtract a value from the attribute names.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to subtract from the attribute names.
Return type:: None

sum()[source]#

Query the sum of the attribute names across nodes/edges.

Return type:

SingleAttributeOperand

Returns:

SingleAttributeOperand –

The sum of the attribute names across all: nodes/edges.

to_values()[source]#

Returns an operand representing the values of the attributes.

Return type:: MultipleValuesOperand
Returns:: MultipleValuesOperand – An operand representing the values of the attributes.

trim()[source]#

Trim the attribute names.

The trim method removes leading and trailing whitespace from the attribute names.

Return type:: None

trim_end()[source]#

Trim the end of the attribute names.

The trim_end method removes trailing whitespace from the attribute names.

Return type:: None

trim_start()[source]#

Trim the start of the attribute names.

The trim_start method removes leading whitespace from the attribute names.

Return type:: None

uppercase()[source]#

Convert the attribute names to uppercase.

Return type:: None

class MultipleValuesOperand[source]#

Bases: object

Query API for multiple attribute values in a MedRecord.

absolute()[source]#

Get the absolute value of the multiple values.

Return type:: None

add(value)[source]#

Add a value to the multiple values.

Parameters:: value (SingleValueArithmeticOperand) – The value to add.
Return type:: None

ceil()[source]#

Get the respective ceiling value of the multiple values.

In mathematics and computer science, the ceiling function is the function that rounds a number upward to the nearest integer.

Return type:: None

clone()[source]#

Create a deep clone of the current multiple values query.

Return type:: MultipleValuesOperand
Returns:: MultipleValuesOperand – A deep clone of the current multiple values query.

contains(value)[source]#

Query which multiple values contain a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

count()[source]#

Get the number of multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The number of multiple values.

divide(value)[source]#

Divide the multiple values by a value.

Parameters:: value (SingleValueArithmeticOperand) – The value to divide by.
Return type:: None

either_or(either, or_)[source]#

Apply either-or logic to the current multiple values query.

This method applies the combination of the two queries to the multiple values query. It returns all multiple values that satisfy either the first query or the second query.

Parameters:

either (Callable[[MultipleValuesOperand], None]) – One of the queries to apply.
or (Callable[[MultipleValuesOperand], None]) – The other query to apply.

Return type:

None

Example

multiple_values_operand.either_or(
    lambda values: values.is_int(), lambda values: values.is_float()
)

ends_with(value)[source]#

Query which multiple values end with a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

equal_to(value)[source]#

Query which multiple values are equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude multiple values based on the query.

Parameters:: query (Callable[[MultipleValuesOperand], None]) – The query to apply to exclude multiple values.
Return type:: None

first()[source]#

Get the first value of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The first value of the multiple values.

floor()[source]#

Get the respective floor of the multiple values.

In mathematics and computer science, the floor function is the function that rounds a number downward to the nearest integer.

Return type:: None

greater_than(value)[source]#

Query which multiple values are greater than a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(value)[source]#

Query which multiple values are greater than or equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

is_bool()[source]#

Query which multiple values are booleans.

Return type:: None

is_datetime()[source]#

Query which multiple values are datetimes.

Return type:: None

is_duration()[source]#

Query which multiple values are durations (timedeltas).

Return type:: None

is_float()[source]#

Query which multiple values are floats.

Return type:: None

is_in(values)[source]#

Query which multiple values are in a list of values.

Parameters:: values (MultipleValuesComparisonOperand) – The values to compare against.
Return type:: None

is_int()[source]#

Query which multiple values are integers.

Return type:: None

is_max()[source]#

Query which multiple values are the maximum value.

Return type:: None

is_min()[source]#

Query which multiple values are the minimum value.

Return type:: None

is_not_in(values)[source]#

Query which multiple values are not in a list of values.

Parameters:: values (MultipleValuesComparisonOperand) – The values to compare against.
Return type:: None

is_null()[source]#

Query which multiple values are null (None).

Return type:: None

is_string()[source]#

Query which multiple values are strings.

Return type:: None

last()[source]#

Get the last value of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The last value of the multiple values.

less_than(value)[source]#

Query which multiple values are less than a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(value)[source]#

Query which multiple values are less than or equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

lowercase()[source]#

Convert the multiple values to lowercase.

Return type:: None

max()[source]#

Get the maximum value of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The maximum value of the multiple values.

mean()[source]#

Get the mean of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The mean of the multiple values.

median()[source]#

Get the median of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The median of the multiple values.

min()[source]#

Get the minimum value of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The minimum value of the multiple values.

mode()[source]#

Get the mode of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The mode of the multiple values.

modulo(value)[source]#

Compute the modulo of the multiple values.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: value (SingleValueArithmeticOperand) – The value to divide by when computing the modulo.
Return type:: None

multiply(value)[source]#

Multiply the multiple values by a value.

Parameters:: value (SingleValueArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(value)[source]#

Query which multiple values are not equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

power(value)[source]#

Raise the multiple values to a power.

Parameters:: value (SingleValueArithmeticOperand) – The power to raise the multiple values to.
Return type:: None

round()[source]#

Round the multiple values.

Return type:: None

slice(start, end)[source]#

Slice the multiple values.

The slice method extracts a section of the multiple values.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

sqrt()[source]#

Get the square root of the multiple values.

Return type:: None

starts_with(value)[source]#

Query which multiple values start with a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

std()[source]#

Get the standard deviation of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The standard deviation of the multiple values.

subtract(value)[source]#

Subtract a value from the multiple values.

Parameters:: value (SingleValueArithmeticOperand) – The value to subtract.
Return type:: None

sum()[source]#

Get the sum of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The sum of the multiple values.

trim()[source]#

Trim the multiple values.

The trim method removes leading and trailing whitespace from the multiple values.

Return type:: None

trim_end()[source]#

Trim the end of the multiple values.

The trim_end method removes trailing whitespace from the multiple values.

Return type:: None

trim_start()[source]#

Trim the start of the multiple values.

The trim_start method removes leading whitespace from the multiple values.

Return type:: None

uppercase()[source]#

Convert the multiple values to uppercase.

Return type:: None

var()[source]#

Get the variance of the multiple values.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – The variance of the multiple values.

class NodeIndexOperand[source]#

Bases: object

Query API for a node index in a MedRecord.

absolute()[source]#

Get the absolute value of the node index.

Return type:: None

add(index)[source]#

Add a value to the node index.

Parameters:: index (NodeIndexArithmeticOperand) – The value to add.
Return type:: None

clone()[source]#

Create a deep clone of the current node index query.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – A deep clone of the current node index query.

contains(index)[source]#

Query whether the node index contains a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

either_or(either, or_)[source]#

Apply either-or logic to the current node index query.

This method evaluates two queries on the node index and returns the node index that satisfies either the first query or the second query.

Parameters:

either (Callable[[NodeIndexOperand], None]) – One of the queries to apply.
or (Callable[[NodeIndexOperand], None]) – The other query to apply.

Return type:

None

Example

node_index_operand.either_or(
    lambda index: index.is_int(), lambda index: index.is_float()
)

ends_with(index)[source]#

Query whether the node index ends with a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

equal_to(index)[source]#

Query whether the node index is equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude the node index if the query is satisfied.

Parameters:: query (Callable[[NodeIndexOperand], None]) – The query to apply to exclude node indices.
Return type:: None

greater_than(index)[source]#

Query whether the node index is greater than a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(index)[source]#

Query whether the node index is greater than or equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

is_in(indices)[source]#

Query whether the node index is in a list of values.

Parameters:: indices (NodeIndicesComparisonOperand) – The values to compare against.
Return type:: None

is_not_in(indices)[source]#

Query whether the node index is not in a list of values.

Parameters:: indices (NodeIndicesComparisonOperand) – The values to compare against.
Return type:: None

less_than(index)[source]#

Query whether the node index is less than a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(index)[source]#

Query whether the node index is less than or equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

lowercase()[source]#

Convert the node index to lowercase.

Return type:: None

modulo(index)[source]#

Compute the modulo of the node index by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: index (NodeIndexArithmeticOperand) – The index to divide by when computing the modulo.
Return type:: None

multiply(index)[source]#

Multiply the node index by a value.

Parameters:: index (NodeIndexArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(index)[source]#

Query whether the node index is not equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

power(index)[source]#

Raise the node index to a power.

Parameters:: index (NodeIndexArithmeticOperand) – The power to raise the node index to.
Return type:: None

slice(start, end)[source]#

Slice the node index.

The slice method extracts a section of the node index.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

starts_with(index)[source]#

Query whether the node index starts with a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

subtract(index)[source]#

Subtract a value from the node index.

Parameters:: index (NodeIndexArithmeticOperand) – The value to subtract.
Return type:: None

trim()[source]#

Trim the node index.

The trim method removes leading and trailing whitespace from the node index.

Return type:: None

trim_end()[source]#

Trim the end of the node index.

This method removes trailing whitespace from the node index.

Return type:: None

trim_start()[source]#

Trim the start of the node index.

This method removes leading whitespace from the node index.

Return type:: None

uppercase()[source]#

Convert the node index to uppercase.

Return type:: None

class NodeIndicesOperand[source]#

Bases: object

Query API for node indices in a MedRecord.

absolute()[source]#

Get the absolute value of the node indices.

Return type:: None

add(index)[source]#

Add a value to the node indices.

Parameters:: index (NodeIndexArithmeticOperand) – The value to add.
Return type:: None

clone()[source]#

Create a deep clone of the current node indices query.

Return type:: NodeIndicesOperand
Returns:: NodeIndicesOperand – A deep clone of the current node indices query.

contains(index)[source]#

Query which node indices contain a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

count()[source]#

Queries and returns the number of node indices.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The number of node indices.

either_or(either, or_)[source]#

Apply either-or logic to the current node indices query.

This method evaluates two queries on the node indices and returns all node indices that satisfy either the first query or the second query.

Parameters:

either (Callable[[NodeIndicesOperand], None]) – One of the queries to apply.
or (Callable[[NodeIndicesOperand], None]) – The other query to apply.

Return type:

None

Example

node_indices_operand.either_or(
    lambda node_indices: node_indices.is_int(),
    lambda node_indices: node_indices.is_float(),
)

ends_with(index)[source]#

Query which node indices end with a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

equal_to(index)[source]#

Query which node indices are equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude node indices based on the query.

Parameters:: query (Callable[[NodeIndicesOperand], None]) – The query to apply to exclude node indices.
Return type:: None

first()[source]#

Queries and returns the first node index.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The first node index.

greater_than(index)[source]#

Query which node indices are greater than a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(index)[source]#

Query which node indices are greater than or equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

is_in(indices)[source]#

Query which node indices are in a list of values.

Parameters:: indices (NodeIndicesComparisonOperand) – The values to compare against.
Return type:: None

is_not_in(indices)[source]#

Query which node indices are not in a list of values.

Parameters:: indices (NodeIndicesComparisonOperand) – The values to compare against.
Return type:: None

last()[source]#

Queries and returns the last node index.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The last node index.

less_than(index)[source]#

Query which node indices are less than a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(index)[source]#

Query which node indices are less than or equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

lowercase()[source]#

Convert the node indices to lowercase.

Return type:: None

max()[source]#

Queries and returns the node index operand with the maximum value.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The node index operand with the maximum value.

min()[source]#

Queries and returns the node index operand with the minimum value.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The node index operand with the minimum value.

modulo(index)[source]#

Compute the modulo of the node indices by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: index (NodeIndexArithmeticOperand) – The index to divide by when computing the modulo.
Return type:: None

multiply(index)[source]#

Multiply the node indices by a value.

Parameters:: index (NodeIndexArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(index)[source]#

Query which node indices are not equal to a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

power(index)[source]#

Raise the node indices to a power.

Parameters:: index (NodeIndexArithmeticOperand) – The power to raise the node indices to.
Return type:: None

slice(start, end)[source]#

Slice the node indices.

The slice method extracts a section of the node indices.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

starts_with(index)[source]#

Query which node indices start with a value.

Parameters:: index (NodeIndexComparisonOperand) – The value to compare against.
Return type:: None

subtract(index)[source]#

Subtract a value from the node indices.

Parameters:: index (NodeIndexArithmeticOperand) – The value to subtract.
Return type:: None

sum()[source]#

Queries and returns the sum of the node indices.

Return type:: NodeIndexOperand
Returns:: NodeIndexOperand – The sum of the node indices.

trim()[source]#

Trim the node indices.

The trim method removes leading and trailing whitespace from the node indices.

Return type:: None

trim_end()[source]#

Trim the end of the node indices.

This method removes trailing whitespace from the node indices.

Return type:: None

trim_start()[source]#

Trim the start of the node indices.

This method removes leading whitespace from the node indices.

Return type:: None

uppercase()[source]#

Convert the node indices to uppercase.

Return type:: None

class NodeOperand[source]#

Bases: object

Query API for nodes in a MedRecord.

attribute(attribute)[source]#

Returns an operand representing the values of that attribute for the nodes.

This method is used to query the values of an attribute for the nodes in the current node query.

Parameters:

attribute (MedRecordAttribute) – The attribute to query.

Return type:

MultipleValuesOperand

Returns:

MultipleValuesOperand –

The operand representing the values of the attribute: for the nodes in the current node query.

attributes()[source]#

Returns an operand representing all the attributes of the nodes queried.

This method is used to query all the attributes of the nodes in the current node query.

Return type:

AttributesTreeOperand

Returns:

AttributesTreeOperand –

The operand representing all the attributes of the: nodes in the current node query.

clone()[source]#

Create a deep clone of the current node query.

Return type:: NodeOperand
Returns:: NodeOperand – A deep clone of the current node query.

edges(direction=EdgeDirection.BOTH)[source]#

Get an edges operand for the current node query.

It is used to query the edges connecting the nodes defined after this node operand, having the direction specified.

Parameters:: direction (EdgeDirection) – The direction of the edges to consider. Defaults to EdgeDirection.BOTH.
Return type:: EdgeOperand
Returns:: EdgeOperand – The edges connecting the nodes defined after this node operand.

Example

node_operand.edges(EdgeDirection.OUTGOING).attribute("weight").greater_than(10)

either_or(either, or_)[source]#

Apply either-or logic to the current node query.

It applies the combination of the two queries to the node query. It returns all nodes that satisfy either the first query or the second query.

Parameters:

either (Callable[[EdgeIndexOperand], None]) – One of the queries to apply.
or (Callable[[EdgeIndexOperand], None]) – The other query to apply.

Return type:

None

Example

node_operand.either_or(
    lambda node: node.attribute("age").greater_than(10),
    lambda node: node.attribute("age").less_than(10),
)

exclude(query)[source]#

Exclude nodes based on the query.

Parameters:: query (Callable[[EdgeIndexOperand], None]) – The query to apply to exclude nodes.
Return type:: None

has_attribute(attribute)[source]#

Queries the nodes that have all the attributes specified.

Parameters:: attribute (Union[MedRecordAttribute, List[MedRecordAttribute]]) – The attribute or attributes to check for.
Return type:: None

in_group(group)[source]#

Queries the nodes that are in all the groups specified.

Parameters:: group (Union[Group, List[Group]]) – The group or groups to query.
Return type:: None

index()[source]#

Returns an operand representing the indices of the nodes queried.

This method is used to query the indices of the nodes in the current node query.

Return type:

NodeIndicesOperand

Returns:

NodeIndicesOperand –

The operand representing the indices of the nodes in the: current node query.

neighbors(edge_direction=EdgeDirection.OUTGOING)[source]#

Get a neighbors operand for the current node query.

It is used to query the nodes that have an edge connecting them to the neighbors defined after this node operand.

Parameters:: edge_direction (EdgeDirection) – The direction of the edges to consider. Defaults to EdgeDirection.OUTGOING.
Return type:: NodeOperand
Returns:: NodeOperand – The neighbors of the current node query.

Example

node_operand.neighbors(EdgeDirection.OUTGOING).in_group(patients_group)

class SingleAttributeOperand[source]#

Bases: object

Query API for a single attribute name in a MedRecord.

absolute()[source]#

Get the absolute value of the single attribute name.

Return type:: None

add(attribute)[source]#

Add a value to the single attribute name.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to add.
Return type:: None

clone()[source]#

Create a deep clone of the current single attribute name query.

Return type:

SingleAttributeOperand

Returns:

SingleAttributeOperand –

A deep clone of the current single attribute name: query.

contains(attribute)[source]#

Query if the single attribute name contains a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

either_or(either, or_)[source]#

Apply either-or logic to the current single attribute name query.

This method evaluates two queries on the single attribute name and returns the attribute name that satisfies either the first query or the second query.

Parameters:

either (Callable[[SingleAttributeOperand], None]) – One of the queries to apply.
or (Callable[[SingleAttributeOperand], None]) – The other query to apply.

Return type:

None

Example

single_attribute_operand.either_or(
    lambda attribute: attribute.is_in(["a", "b"]),
    lambda attribute: attribute.is_in(["A", "B"]),
)

ends_with(attribute)[source]#

Query if the single attribute name ends with a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

equal_to(attribute)[source]#

Query if the single attribute name is equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude the single attribute name if it satisfies the query.

Parameters:: query (Callable[[SingleAttributeOperand], None]) – The query to apply to exclude the value.
Return type:: None

greater_than(attribute)[source]#

Query if the single attribute name is greater than a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(attribute)[source]#

Query if the single attribute name is greater than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

is_in(attributes)[source]#

Query if the single attribute name is in a list of values.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The values to compare against.
Return type:: None

is_int()[source]#

Query if the single attribute name is an integer.

Return type:: None

is_not_in(attributes)[source]#

Query if the single attribute name is not in a list of values.

Parameters:: attributes (MultipleAttributesComparisonOperand) – The values to compare against.
Return type:: None

is_string()[source]#

Query if the single attribute name is a string.

Return type:: None

less_than(attribute)[source]#

Query if the single attribute name is less than a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(attribute)[source]#

Query if the single attribute name is less than or equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

lowercase()[source]#

Convert the single attribute name to lowercase.

Return type:: None

modulo(attribute)[source]#

Compute the modulo of the single attribute name by a value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to divide by when computing the modulo.
Return type:: None

multiply(attribute)[source]#

Multiply the single attribute name by a value.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(attribute)[source]#

Query if the single attribute name is not equal to a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

power(attribute)[source]#

Raise the single attribute name to a power.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The power to raise the single attribute name to.
Return type:: None

slice(start, end)[source]#

Slice the single attribute name.

The slice method extracts a section of the single attribute name.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

starts_with(attribute)[source]#

Query if the single attribute name starts with a value.

Parameters:: attribute (SingleAttributeComparisonOperand) – The value to compare against.
Return type:: None

subtract(attribute)[source]#

Subtract a value from the single attribute name.

Parameters:: attribute (SingleAttributeArithmeticOperand) – The value to subtract.
Return type:: None

trim()[source]#

Trim the single attribute name.

The trim method removes leading and trailing whitespace from the single attribute name.

Return type:: None

trim_end()[source]#

Trim the end of the single attribute name.

The trim_end method removes trailing whitespace from the single attribute name.

Return type:: None

trim_start()[source]#

Trim the start of the single attribute name.

The trim_start method removes leading whitespace from the single attribute name.

Return type:: None

uppercase()[source]#

Convert the single attribute name to uppercase.

Return type:: None

class SingleValueOperand[source]#

Bases: object

Query API for a single value in a MedRecord.

absolute()[source]#

Get the absolute value of the single value.

Return type:: None

add(value)[source]#

Add a value to the single value.

Parameters:: value (SingleValueArithmeticOperand) – The value to add.
Return type:: None

ceil()[source]#

Get the respective ceiling value of the single value.

In mathematics and computer science, the ceiling function is the function that rounds a number upward to the nearest integer.

Return type:: None

clone()[source]#

Create a deep clone of the current single value query.

Return type:: SingleValueOperand
Returns:: SingleValueOperand – A deep clone of the current single value query.

contains(value)[source]#

Query if the single value contains a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

either_or(either, or_)[source]#

Apply either-or logic to the current single value query.

This method applies the combination of the two queries to the single value query. It returns all single values that satisfy either the first query or the second query.

Parameters:

either (Callable[[SingleValueOperand], None]) – One of the queries to apply.
or (Callable[[SingleValueOperand], None]) – The other query to apply.

Return type:

None

Example

single_value_operand.either_or(
    lambda value: value.is_int(), lambda value: value.is_float()
)

ends_with(value)[source]#

Query if the single value ends with a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

equal_to(value)[source]#

Query if the single value is equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

exclude(query)[source]#

Exclude the single value if it satisfies the query.

Parameters:: query (Callable[[SingleValueOperand], None]) – The query to apply to exclude the value.
Return type:: None

floor()[source]#

Get the respective floor of the single value.

Return type:: None

greater_than(value)[source]#

Query if the single value is greater than a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

greater_than_or_equal_to(value)[source]#

Query if the single value is greater than or equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

is_bool()[source]#

Query if the single value is a boolean.

Return type:: None

is_datetime()[source]#

Query if the single value is a datetime.

Return type:: None

is_duration()[source]#

Query if the single value is a duration (timedelta).

Return type:: None

is_float()[source]#

Query if the single value is a float.

Return type:: None

is_in(values)[source]#

Query if the single value is in a list of values.

Parameters:: values (MultipleValuesComparisonOperand) – The values to compare against.
Return type:: None

is_int()[source]#

Query if the single value is an integer.

Return type:: None

is_not_in(values)[source]#

Query if the single value is not in a list of values.

Parameters:: values (MultipleValuesComparisonOperand) – The values to compare against.
Return type:: None

is_null()[source]#

Query if the single value is null (None).

Return type:: None

is_string()[source]#

Query if the single value is a string.

Return type:: None

less_than(value)[source]#

Query if the single value is less than a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

less_than_or_equal_to(value)[source]#

Query if the single value is less than or equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

lowercase()[source]#

Convert the single value to lowercase.

Return type:: None

modulo(value)[source]#

Compute the modulo of the single value.

In mathematics and computer science, the modulo operation finds the remainder after division of one number by another.

Parameters:: value (SingleValueArithmeticOperand) – The value to divide by when computing the modulo.
Return type:: None

multiply(value)[source]#

Multiply the single value by a value.

Parameters:: value (SingleValueArithmeticOperand) – The value to multiply by.
Return type:: None

not_equal_to(value)[source]#

Query if the single value is not equal to a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

power(value)[source]#

Raise the single value to a power.

Parameters:: value (SingleValueArithmeticOperand) – The power to raise the value to.
Return type:: None

round()[source]#

Round the single value.

Return type:: None

slice(start, end)[source]#

Slice the single value.

The slice method extracts a section of the single value.

Parameters:

start (int) – The start index of the slice.
end (int) – The end index of the slice.

Return type:

None

sqrt()[source]#

Get the square root of the single value.

Return type:: None

starts_with(value)[source]#

Query if the single value starts with a value.

Parameters:: value (SingleValueComparisonOperand) – The value to compare against.
Return type:: None

subtract(value)[source]#

Subtract a value from the single value.

Parameters:: value (SingleValueArithmeticOperand) – The value to subtract.
Return type:: None

trim()[source]#

Trim the single value.

The trim method removes leading and trailing whitespace from the single value.

Return type:: None

trim_end()[source]#

Trim the end of the single value.

The trim_end method removes trailing whitespace from the single value.

Return type:: None

trim_start()[source]#

Trim the start of the single value.

The trim_start method removes leading whitespace from the single value.

Return type:: None

uppercase()[source]#

Convert the single value to uppercase.

Return type:: None