Class WfsFilterCondition<WfsXmlTypes>

Base class for all filter conditions.

Type Parameters

WfsXmlTypes extends XmlTypes = XmlTypes

Hierarchy (View Summary)

BaseFilterCondition<WfsXmlTypes>
- WfsFilterCondition

Constructors

constructor

new WfsFilterCondition<WfsXmlTypes extends string = string>(
    property: string,
    operator:
        | "eq"
        | "neq"
        | "gt"
        | "gte"
        | "lt"
        | "lte"
        | "like"
        | "nlike"
        | "in"
        | "nin"
        | "before"
        | "after"
        | "between"
        | "nbetween"
        | "nul"
        | "nnul"
        | "intersects"
        | "within"
        | "contains",
    value?: string,
    value2?: string,
    propertyType?: WfsXmlTypes,
): WfsFilterCondition<WfsXmlTypes>
Type Parameters
- WfsXmlTypes extends string = string
Parameters
- property: string
- operator:
      | "eq"
      | "neq"
      | "gt"
      | "gte"
      | "lt"
      | "lte"
      | "like"
      | "nlike"
      | "in"
      | "nin"
      | "before"
      | "after"
      | "between"
      | "nbetween"
      | "nul"
      | "nnul"
      | "intersects"
      | "within"
      | "contains"
- Optionalvalue: string
- Optionalvalue2: string
- OptionalpropertyType: WfsXmlTypes
Returns WfsFilterCondition<WfsXmlTypes>
Overrides BaseFilterCondition.constructor
- Defined in tools/wfs/wfsfiltercondition.ts:90

Properties

operator

operator:
    | "eq"
    | "neq"
    | "gt"
    | "gte"
    | "lt"
    | "lte"
    | "like"
    | "nlike"
    | "in"
    | "nin"
    | "before"
    | "after"
    | "between"
    | "nbetween"
    | "nul"
    | "nnul"
    | "intersects"
    | "within"
    | "contains"

property

property: string

`Optional`propertyType

propertyType?: WfsXmlTypes

`Optional`propertyTypeGroup

propertyTypeGroup?: AttributeTypeGroup

value

value: string

value2

value2: string

Accessors

isSimpleCondition

get isSimpleCondition(): boolean
Is this a condition that can be displayed in a simple layer tree filter?

Returns boolean
- Defined in tools/wfs/wfsfiltercondition.ts:56

`Static`supportedOperators

get supportedOperators(): {
    displayName: string;
    operator: | "eq"
    | "neq"
    | "gt"
    | "gte"
    | "lt"
    | "lte"
    | "like"
    | "nlike"
    | "in"
    | "nin"
    | "before"
    | "after"
    | "between"
    | "nbetween"
    | "nul"
    | "nnul"
    | "intersects"
    | "within"
    | "contains";
}[]
Returns the supported operators for the given filter class.

Returns {
    displayName: string;
    operator:
        | "eq"
        | "neq"
        | "gt"
        | "gte"
        | "lt"
        | "lte"
        | "like"
        | "nlike"
        | "in"
        | "nin"
        | "before"
        | "after"
        | "between"
        | "nbetween"
        | "nul"
        | "nnul"
        | "intersects"
        | "within"
        | "contains";
}[]
Overrides BaseFilterCondition.supportedOperators
- Defined in tools/wfs/wfsfiltercondition.ts:108

Methods

toOpenLayersFilter

toOpenLayersFilter(): Filter
Returns Filter
- Defined in tools/wfs/wfsfiltercondition.ts:131

toTextRepresentation

toTextRepresentation(
context: IGirafeContext,
propertyDisplayName?: string,
): string
Generates a simple text representation of the filter, for example, "attributeName [attributeType] = value" Needs the context to translate the operator and other terms. If instead of the attribute name and type, an alias or translated name should be displayed, provide the string via the optional propertyDisplayName parameter
Parameters
- context: IGirafeContext
- OptionalpropertyDisplayName: string
Returns string
Inherited from BaseFilterCondition.toTextRepresentation
- Defined in tools/filter/basefilter.ts:71

toWmsGetMapFilter

toWmsGetMapFilter(): string
Returns string
a simple filter string that can be used in a WMS GetMap request, does not provide any XML namespace (xmlns attributes)
- Defined in tools/wfs/wfsfiltercondition.ts:215

`Static`buildNestedExpression

buildNestedExpression(
filterStrings: string[],
logicalOperator: "and" | "or" | "not",
): string
Parameters
- filterStrings: string[]
- logicalOperator: "and" | "or" | "not"
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:349

`Protected` `Static`simpleBetweenFilter

simpleBetweenFilter(name: string, value: string, value2: string): string
Parameters
- name: string
- value: string
- value2: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:299

`Protected` `Static`simpleContainsFilter

simpleContainsFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:332

`Protected` `Static`simpleEqFilter

simpleEqFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:275

`Protected` `Static`simpleGteFilter

simpleGteFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:295

`Protected` `Static`simpleGtFilter

simpleGtFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:291

`Protected` `Static`simpleInFilter

simpleInFilter(name: string, valueList: string[]): string
Parameters
- name: string
- valueList: string[]
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:322

`Protected` `Static`simpleInnerLikeFilter

simpleInnerLikeFilter(name: string, value: string, wildCard?: string): string
Parameters
- name: string
- value: string
- OptionalwildCard: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:307

`Protected` `Static`simpleIntersectsFilter

simpleIntersectsFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:336

`Protected` `Static`simpleLikeFilter

simpleLikeFilter(name: string, value: string, wildCard?: string): string
Parameters
- name: string
- value: string
- OptionalwildCard: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:314

`Protected` `Static`simpleLikeFilterGenerateWildCard

simpleLikeFilterGenerateWildCard(value: string): string
Parameters
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:345

`Protected` `Static`simpleLteFilter

simpleLteFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:287

`Protected` `Static`simpleLtFilter

simpleLtFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:283

`Protected` `Static`simpleNbetweenFilter

simpleNbetweenFilter(name: string, value: string, value2: string): string
Parameters
- name: string
- value: string
- value2: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:303

`Protected` `Static`simpleNeqFilter

simpleNeqFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:279

`Protected` `Static`simpleNinFilter

simpleNinFilter(name: string, valueList: string[]): string
Parameters
- name: string
- valueList: string[]
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:327

`Protected` `Static`simpleNlikeFilter

simpleNlikeFilter(name: string, value: string, wildCard?: string): string
Parameters
- name: string
- value: string
- OptionalwildCard: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:318

`Protected` `Static`simpleWithinFilter

simpleWithinFilter(name: string, value: string): string
Parameters
- name: string
- value: string
Returns string
- Defined in tools/wfs/wfsfiltercondition.ts:340

`Static`supportedOperatorsByAttributeType

supportedOperatorsByAttributeType(
    attributeType: string,
): {
    displayName: string;
    operator:
        | "eq"
        | "neq"
        | "gt"
        | "gte"
        | "lt"
        | "lte"
        | "like"
        | "nlike"
        | "in"
        | "nin"
        | "before"
        | "after"
        | "between"
        | "nbetween"
        | "nul"
        | "nnul"
        | "intersects"
        | "within"
        | "contains";
}[]
Returns the supported operators for the given attribute type.
Parameters
- attributeType: string
Returns {
    displayName: string;
    operator:
        | "eq"
        | "neq"
        | "gt"
        | "gte"
        | "lt"
        | "lte"
        | "like"
        | "nlike"
        | "in"
        | "nin"
        | "before"
        | "after"
        | "between"
        | "nbetween"
        | "nul"
        | "nnul"
        | "intersects"
        | "within"
        | "contains";
}[]
Overrides BaseFilterCondition.supportedOperatorsByAttributeType
- Defined in tools/wfs/wfsfiltercondition.ts:117

Class WfsFilterCondition<WfsXmlTypes>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WfsFilterCondition<WfsXmlTypes>

Properties

operator

property

OptionalpropertyType

OptionalpropertyTypeGroup

value

value2

Accessors

isSimpleCondition

Returns boolean

StaticsupportedOperators

Returns { displayName: string; operator: | "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "like" | "nlike" | "in" | "nin" | "before" | "after" | "between" | "nbetween" | "nul" | "nnul" | "intersects" | "within" | "contains";}[]

Methods

toOpenLayersFilter

Returns Filter

toTextRepresentation

Parameters

Returns string

toWmsGetMapFilter

Returns string

StaticbuildNestedExpression

Parameters

Returns string

Protected StaticsimpleBetweenFilter

Parameters

Returns string

Protected StaticsimpleContainsFilter

Parameters

Returns string

Protected StaticsimpleEqFilter

Parameters

Returns string

Protected StaticsimpleGteFilter

Parameters

Returns string

Protected StaticsimpleGtFilter

Parameters

Returns string

Protected StaticsimpleInFilter

Parameters

Returns string

Protected StaticsimpleInnerLikeFilter

Parameters

Returns string

Protected StaticsimpleIntersectsFilter

Parameters

Returns string

Protected StaticsimpleLikeFilter

Parameters

Returns string

Protected StaticsimpleLikeFilterGenerateWildCard

Parameters

Returns string

Protected StaticsimpleLteFilter

Parameters

Returns string

Protected StaticsimpleLtFilter

Parameters

Returns string

Protected StaticsimpleNbetweenFilter

Parameters

Returns string

Protected StaticsimpleNeqFilter

Parameters

Returns string

Protected StaticsimpleNinFilter

Parameters

`Optional`propertyType

`Optional`propertyTypeGroup

`Static`supportedOperators

Returns {
displayName: string;
operator:
| "eq"
| "neq"
| "gt"
| "gte"
| "lt"
| "lte"
| "like"
| "nlike"
| "in"
| "nin"
| "before"
| "after"
| "between"
| "nbetween"
| "nul"
| "nnul"
| "intersects"
| "within"
| "contains";
}[]

`Static`buildNestedExpression

`Protected` `Static`simpleBetweenFilter

`Protected` `Static`simpleContainsFilter

`Protected` `Static`simpleEqFilter

`Protected` `Static`simpleGteFilter

`Protected` `Static`simpleGtFilter

`Protected` `Static`simpleInFilter

`Protected` `Static`simpleInnerLikeFilter

`Protected` `Static`simpleIntersectsFilter

`Protected` `Static`simpleLikeFilter

`Protected` `Static`simpleLikeFilterGenerateWildCard

`Protected` `Static`simpleLteFilter

`Protected` `Static`simpleLtFilter

`Protected` `Static`simpleNbetweenFilter

`Protected` `Static`simpleNeqFilter

`Protected` `Static`simpleNinFilter

`Protected` `Static`simpleNlikeFilter

`Protected` `Static`simpleWithinFilter

`Static`supportedOperatorsByAttributeType

Returns {
displayName: string;
operator:
| "eq"
| "neq"
| "gt"
| "gte"
| "lt"
| "lte"
| "like"
| "nlike"
| "in"
| "nin"
| "before"
| "after"
| "between"
| "nbetween"
| "nul"
| "nnul"
| "intersects"
| "within"
| "contains";
}[]