Type Members

1.  sealed trait AbbrevForwardStep extends ForwardStep
2.  sealed trait AdditionOp extends XPathElem with LeafElem
3.  final case class AdditiveExpr(firstExpr: MultiplicativeExpr, operatorExprPairs: IndexedSeq[(AdditionOp, MultiplicativeExpr)]) extends XPathElem with Product with Serializable
4.  final case class AndExpr(comparisonExprs: IndexedSeq[ComparisonExpr]) extends XPathElem with Product with Serializable
5.  sealed trait Argument extends XPathElem
6.  final case class ArgumentList(arguments: IndexedSeq[Argument]) extends Postfix with Product with Serializable
7.  sealed trait ArrayConstructor extends PrimaryExpr
8.  sealed trait ArrayTest extends ItemType
9.  final case class ArrowExpr(unaryExpr: UnaryExpr, arrowFunctionCalls: IndexedSeq[ArrowFunctionCall]) extends XPathElem with Product with Serializable
10.  final case class ArrowFunctionCall(arrowFunctionSpecifier: ArrowFunctionSpecifier, argumentList: ArgumentList) extends XPathElem with Product with Serializable
11.  sealed trait ArrowFunctionSpecifier extends XPathElem
12.  final case class AtomicOrUnionType(tpe: EQName) extends ItemType with LeafElem with Product with Serializable
13.  final case class AttributeAxisAbbrevForwardStep(nodeTest: NodeTest) extends AbbrevForwardStep with Product with Serializable
14.  final case class AttributeNameAndTypeTest(name: EQName, tpe: EQName) extends AttributeTest with LeafElem with Product with Serializable
15.  final case class AttributeNameTest(name: EQName) extends AttributeTest with LeafElem with Product with Serializable
16.  sealed trait AttributeTest extends KindTest
17.  final case class AttributeTypeTest(tpe: EQName) extends AttributeTest with LeafElem with Product with Serializable
18.  sealed trait AxisStep extends StepExpr
19.  final case class BracedUriLiteral(namespaceOption: Option[String]) extends Product with Serializable

    Braced URI literal.

20.  final case class CastExpr(arrowExpr: ArrowExpr, singleTypeOption: Option[SingleType]) extends XPathElem with Product with Serializable
21.  final case class CastableExpr(castExpr: CastExpr, singleTypeOption: Option[SingleType]) extends XPathElem with Product with Serializable
22.  sealed trait Comp extends XPathElem with LeafElem
23.  sealed trait ComparisonExpr extends XPathElem
24.  final case class CompoundComparisonExpr(stringConcatExpr1: StringConcatExpr, comp: Comp, stringConcatExpr2: StringConcatExpr) extends ComparisonExpr with Product with Serializable
25.  final case class CompoundRangeExpr(additiveExpr1: AdditiveExpr, additiveExpr2: AdditiveExpr) extends RangeExpr with Product with Serializable
26.  final case class CurlyArrayConstructor(expr: EnclosedExpr) extends ArrayConstructor with Product with Serializable
27.  final case class DataPITest(data: StringLiteral) extends PITest with Product with Serializable
28.  final case class DecimalLiteral(value: BigDecimal) extends NumericLiteral with LeafElem with Product with Serializable
29.  sealed trait DocumentTest extends KindTest
30.  final case class DocumentTestContainingElementTest(elementTest: ElementTest) extends DocumentTest with Product with Serializable
31.  final case class DocumentTestContainingSchemaElementTest(schemaElementTest: SchemaElementTest) extends DocumentTest with Product with Serializable
32.  final case class DoubleLiteral(value: Double) extends NumericLiteral with LeafElem with Product with Serializable
33.  sealed trait EQName extends AnyRef

    EQName, so either a URIQualifiedName or a QName.

34.  final case class EQNameAsArrowFunctionSpecifier(eqName: EQName) extends ArrowFunctionSpecifier with LeafElem with Product with Serializable
35.  final case class ElementNameAndTypeTest(name: EQName, tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
36.  final case class ElementNameTest(name: EQName) extends ElementTest with LeafElem with Product with Serializable
37.  sealed trait ElementTest extends KindTest
38.  final case class ElementTypeTest(tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
39.  final case class EnclosedExpr(exprOption: Option[Expr]) extends XPathElem with Product with Serializable
40.  final case class ExactlyOneSequenceType(itemType: ItemType) extends SequenceType with Product with Serializable
41.  final case class Expr(exprSingleSeq: IndexedSeq[ExprSingle]) extends XPathElem with Product with Serializable
42.  sealed trait ExprSingle extends XPathElem
43.  final case class ExprSingleArgument(exprSingle: ExprSingle) extends Argument with Product with Serializable
44.  final case class ForExpr(simpleForBindings: IndexedSeq[SimpleForBinding], returnExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
45.  sealed trait ForwardAxis extends XPathElem with LeafElem
46.  final case class ForwardAxisStep(step: ForwardStep, predicateList: IndexedSeq[Predicate]) extends AxisStep with Product with Serializable
47.  sealed trait ForwardStep extends XPathElem
48.  final case class FunctionCall(functionName: EQName, argumentList: ArgumentList) extends PrimaryExpr with Product with Serializable
49.  sealed trait FunctionItemExpr extends PrimaryExpr
50.  sealed trait FunctionTest extends ItemType
51.  sealed trait GeneralComp extends Comp
52.  final case class IfExpr(condition: Expr, thenExpr: ExprSingle, elseExpr: ExprSingle) extends ExprSingle with Product with Serializable
53.  final case class InlineFunctionExpr(paramListOption: Option[ParamList], resultTypeOption: Option[SequenceType], body: EnclosedExpr) extends FunctionItemExpr with Product with Serializable
54.  final case class InstanceOfExpr(treatExpr: TreatExpr, sequenceTypeOption: Option[SequenceType]) extends XPathElem with Product with Serializable
55.  final case class IntegerLiteral(value: BigInt) extends NumericLiteral with LeafElem with Product with Serializable
56.  final case class IntersectExceptExpr(firstExpr: InstanceOfExpr, operatorExprPairs: IndexedSeq[(IntersectExceptOp, InstanceOfExpr)]) extends XPathElem with Product with Serializable
57.  sealed trait IntersectExceptOp extends XPathElem with LeafElem
58.  sealed trait ItemType extends XPathElem
59.  sealed trait KeySpecifier extends XPathElem
60.  sealed trait KindTest extends NodeTest
61.  final case class KindTestItemType(kindTest: KindTest) extends ItemType with Product with Serializable
62.  sealed trait LeafElem extends XPathElem
63.  final case class LetExpr(simpleLetBindings: IndexedSeq[SimpleLetBinding], returnExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
64.  sealed trait Literal extends PrimaryExpr
65.  final case class LocalNameWildcard(localName: NCName) extends Wildcard with LeafElem with Product with Serializable
66.  final case class MapConstructor(entries: IndexedSeq[MapConstructorEntry]) extends PrimaryExpr with Product with Serializable
67.  final case class MapConstructorEntry(keyExpr: ExprSingle, valueExpr: ExprSingle) extends XPathElem with Product with Serializable
68.  sealed trait MapTest extends ItemType
69.  final case class MultiplicativeExpr(firstExpr: UnionExpr, operatorExprPairs: IndexedSeq[(MultiplicativeOp, UnionExpr)]) extends XPathElem with Product with Serializable
70.  sealed trait MultiplicativeOp extends XPathElem with LeafElem
71.  final case class NCName(name: String) extends Product with Serializable

    NCName, that is, a non-colon name.

72.  sealed trait NameTest extends NodeTest
73.  final case class NamedFunctionRef(functionName: EQName, arity: BigInt) extends FunctionItemExpr with LeafElem with Product with Serializable
74.  final case class NamedKeySpecifier(ncName: NCName) extends KeySpecifier with LeafElem with Product with Serializable
75.  final case class NamespaceWildcard(bracedUriLiteral: BracedUriLiteral) extends Wildcard with LeafElem with Product with Serializable
76.  final case class NillableElementNameAndTypeTest(name: EQName, tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
77.  final case class NillableElementTypeTest(tpe: EQName) extends ElementTest with LeafElem with Product with Serializable
78.  sealed trait NodeComp extends Comp
79.  sealed trait NodeTest extends XPathElem
80.  final case class NonAbbrevForwardStep(forwardAxis: ForwardAxis, nodeTest: NodeTest) extends ForwardStep with Product with Serializable
81.  final case class NonAbbrevReverseStep(reverseAxis: ReverseAxis, nodeTest: NodeTest) extends ReverseStep with Product with Serializable
82.  final case class NonEmptySingleType(name: EQName) extends SingleType with LeafElem with Product with Serializable
83.  sealed trait NumericLiteral extends Literal
84.  final case class OneOrMoreSequenceType(itemType: ItemType) extends SequenceType with Product with Serializable
85.  final case class OrExpr(andExprs: IndexedSeq[AndExpr]) extends ExprSingle with Product with Serializable
86.  sealed trait PITest extends KindTest
87.  final case class Param(paramName: EQName, typeDeclarationOption: Option[TypeDeclaration]) extends XPathElem with Product with Serializable
88.  final case class ParamList(params: IndexedSeq[Param]) extends XPathElem with Product with Serializable
89.  final case class ParenthesizedExpr(exprOption: Option[Expr]) extends PrimaryExpr with Product with Serializable
90.  final case class ParenthesizedExprAsArrowFunctionSpecifier(parenthesizedExpr: ParenthesizedExpr) extends ArrowFunctionSpecifier with Product with Serializable
91.  final case class ParenthesizedExprKeySpecifier(parenthesizedExpr: ParenthesizedExpr) extends KeySpecifier with Product with Serializable
92.  final case class ParenthesizedItemType(itemType: ItemType) extends ItemType with Product with Serializable
93.  sealed trait PathExpr extends XPathElem
94.  final case class PathExprStartingWithDoubleSlash(relativePathExpr: RelativePathExpr) extends PathExpr with Product with Serializable
95.  final case class PathExprStartingWithSingleSlash(relativePathExpr: RelativePathExpr) extends PathExpr with Product with Serializable
96.  final case class PositionalKeySpecifier(integerLiteral: IntegerLiteral) extends KeySpecifier with Product with Serializable
97.  sealed trait Postfix extends XPathElem
98.  final case class PostfixExpr(primaryExpr: PrimaryExpr, postfixes: IndexedSeq[Postfix]) extends StepExpr with Product with Serializable
99.  final case class PostfixLookup(keySpecifier: KeySpecifier) extends Postfix with Product with Serializable
100.  final case class PotentiallyEmptySingleType(name: EQName) extends SingleType with LeafElem with Product with Serializable
101.  final case class Predicate(expr: Expr) extends Postfix with Product with Serializable
102.  final case class PrefixWildcard(prefix: NCName) extends Wildcard with LeafElem with Product with Serializable
103.  sealed trait PrimaryExpr extends XPathElem
104.  final case class QuantifiedExpr(quantifier: Quantifier, simpleBindings: IndexedSeq[SimpleBindingInQuantifiedExpr], satisfiesExpr: ExprSingle) extends ExprSingle with VariableIntroducingExpr with Product with Serializable
105.  sealed trait Quantifier extends XPathElem with LeafElem
106.  sealed trait RangeExpr extends XPathElem
107.  final case class RelativePathExpr(firstExpr: StepExpr, operatorExprPairs: IndexedSeq[(StepOp, StepExpr)]) extends PathExpr with Product with Serializable
108.  sealed trait ReverseAxis extends XPathElem with LeafElem
109.  final case class ReverseAxisStep(step: ReverseStep, predicateList: IndexedSeq[Predicate]) extends AxisStep with Product with Serializable
110.  sealed trait ReverseStep extends XPathElem
111.  final case class SchemaAttributeTest(name: EQName) extends KindTest with LeafElem with Product with Serializable
112.  final case class SchemaElementTest(name: EQName) extends KindTest with LeafElem with Product with Serializable
113.  sealed trait SequenceType extends XPathElem
114.  final case class SimpleAbbrevForwardStep(nodeTest: NodeTest) extends AbbrevForwardStep with Product with Serializable
115.  final case class SimpleBindingInQuantifiedExpr(varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
116.  final case class SimpleComparisonExpr(stringConcatExpr: StringConcatExpr) extends ComparisonExpr with Product with Serializable
117.  final case class SimpleForBinding(varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
118.  final case class SimpleLetBinding(varName: EQName, expr: ExprSingle) extends VariableBinding with Product with Serializable
119.  final case class SimpleMapExpr(pathExprs: IndexedSeq[PathExpr]) extends XPathElem with Product with Serializable
120.  final case class SimpleNameTest(name: EQName) extends NameTest with LeafElem with Product with Serializable
121.  final case class SimpleRangeExpr(additiveExpr: AdditiveExpr) extends RangeExpr with Product with Serializable
122.  sealed trait SingleType extends XPathElem
123.  final case class SquareArrayConstructor(members: IndexedSeq[ExprSingle]) extends ArrayConstructor with Product with Serializable
124.  sealed trait StepExpr extends XPathElem
125.  sealed trait StepOp extends XPathElem with LeafElem
126.  final case class StringConcatExpr(rangeExprs: IndexedSeq[RangeExpr]) extends XPathElem with Product with Serializable
127.  final case class StringLiteral(value: String) extends Literal with LeafElem with Product with Serializable
128.  final case class TargetPITest(target: NCName) extends PITest with LeafElem with Product with Serializable
129.  final case class TreatExpr(castableExpr: CastableExpr, sequenceTypeOption: Option[SequenceType]) extends XPathElem with Product with Serializable
130.  final case class TypeDeclaration(tpe: SequenceType) extends XPathElem with Product with Serializable
131.  final case class TypedArrayTest(elementType: SequenceType) extends ArrayTest with Product with Serializable
132.  final case class TypedFunctionTest(argumentTypes: IndexedSeq[SequenceType], resultType: SequenceType) extends FunctionTest with Product with Serializable
133.  final case class TypedMapTest(keyType: AtomicOrUnionType, valueType: SequenceType) extends MapTest with Product with Serializable
134.  final case class UnaryExpr(ops: IndexedSeq[UnaryOp], valueExpr: ValueExpr) extends XPathElem with Product with Serializable
135.  final case class UnaryLookup(keySpecifier: KeySpecifier) extends PrimaryExpr with Product with Serializable
136.  sealed trait UnaryOp extends XPathElem with LeafElem
137.  final case class UnionExpr(intersectExceptExprs: IndexedSeq[IntersectExceptExpr]) extends XPathElem with Product with Serializable
138.  sealed trait ValueComp extends Comp
139.  final case class ValueExpr(expr: SimpleMapExpr) extends XPathElem with Product with Serializable
140.  final case class VarRef(varName: EQName) extends PrimaryExpr with LeafElem with Product with Serializable
141.  final case class VarRefAsArrowFunctionSpecifier(varRef: VarRef) extends ArrowFunctionSpecifier with Product with Serializable
142.  sealed trait VariableBinding extends XPathElem

     Binding of a variable name to an expression.

143.  sealed trait VariableIntroducingExpr extends XPathElem

     XPathElem that can introduce one or more variable bindings.

144.  sealed trait Wildcard extends NameTest
145.  sealed trait XPathElem extends ElemLike[XPathElem]

     XPath 3.1 AST.

     XPath 3.1 AST. The root of the type hierarchy is XPathElem. It offers the ElemApi query API.

     The purpose of this AST is as follows:

     • It must represent the syntax tree of a successfully parsed XPath expression
     • It is not annotated with more semantic information, like type information that is not included in the XPath expression
     • It does not know anything about the context in which it runs, like bound namespaces etc.
     • It is rich enough to be able to serialize the AST back to XPath, knowing exactly where to place parentheses, braces, etc.
     • It is rich enough to contain operator precedence in the AST itself
     • Serialization of the AST to XPath may lead to differences in whitespace (and operator aliases), but other than that the result must be the same
     • The AST class hierarchy does not have to use the exact same names as the XPath grammar

     Having such an AST of a successfully parsed XPath expression, it must be easy to reliably find used namespace prefixes, for example.

     TODO Improve several class names.

146.  final case class XPathExpr(expr: Expr) extends XPathElem with Product with Serializable
147.  final case class ZeroOrMoreSequenceType(itemType: ItemType) extends SequenceType with Product with Serializable
148.  final case class ZeroOrOneSequenceType(itemType: ItemType) extends SequenceType with Product with Serializable