Interface ExportAgent

All Known Implementing Classes:
AdjacentTextNodeMerger, AnalyzeString, AncestorQualifiedPattern, AnchorPattern, AndExpression, ApplyImports, ApplyNextMatchingTemplate, ApplyTemplates, ArithmeticExpression, ArithmeticExpression10, Assignation, AtomicSequenceConverter, Atomizer, AttributeCreator, AttributeGetter, AxisExpression, BasePatternWithPredicate, BinaryExpression, Block, BooleanExpression, BooleanExpressionPattern, BreakInstr, CallTemplate, CardinalityChecker, CastableExpression, CastExpression, CastingExpression, Choose, Comment, CompareToConstant, CompareToIntegerConstant, CompareToStringConstant, ComponentTracer, ComputedAttribute, ComputedElement, ConditionalBlock, ConditionalSorter, ConsumingOperand, ContextItemExpression, Copy, CopyOf, CurrentGroupCall, CurrentGroupingKeyCall, CurrentItemExpression, Doctype, DocumentInstr, DocumentSorter, EagerLetExpression, ElementCreator, EmptyTextNodeRemover, EquivalenceComparison, ErrorExpression, EvaluateInstr, ExceptPattern, Expression, FilterExpression, FirstItemExpression, FixedAttribute, FixedElement, FLWORExpression, ForEach, ForEachGroup, ForExpression, Fork, FunctionCall, FunctionLiteral, FunctionSequenceCoercer, GeneralComparison, GeneralComparison10, GeneralComparison20, GeneralNodePattern, GeneralPositionalPattern, GlobalVariableReference, HomogeneityChecker, IdentityComparison, InstanceOfExpression, Instruction, IntegerRangeTest, IntegratedFunctionCall, IntersectPattern, IsLastExpression, ItemChecker, ItemTypePattern, IterateInstr, JAXPVariableReference, LastItemExpression, LetExpression, Literal, LocalParam, LocalParamBlock, LocalVariableReference, LookupAllExpression, LookupExpression, MergeInstr, Message, NamespaceConstructor, NegateExpression, NextIteration, NextMatch, NodeSetPattern, NodeTestPattern, NumberInstruction, NumberSequenceFormatter, OnEmptyExpr, OnNonEmptyExpr, OrExpression, OuterForExpression, ParentNodeConstructor, PartialApply, Pattern, PatternThatSetsCurrent, ProcessingInstruction, PseudoExpression, QuantifiedExpression, RangeExpression, ResultDocument, RootExpression, SequenceInstr, SimpleExpression, SimpleNodeConstructor, SimplePositionalPattern, SimpleStepExpression, SingleItemFilter, SingletonAtomizer, SingletonIntersectExpression, SlashExpression, SortExpression, SortKeyDefinition, SortKeyDefinitionList, SourceDocument, SquareArrayConstructor, StaticFunctionCall, StreamingFunctionArgumentPattern, StringLiteral, SubscriptExpression, SuppliedParameterReference, SystemFunctionCall, SystemFunctionCall.Optimized, TailCallLoop, TailExpression, TraceExpression, TryCatch, TupleExpression, UnaryExpression, UnionPattern, UniversalPattern, UntypedSequenceConverter, UseAttributeSet, UserFunctionCall, UserFunctionReference, ValueComparison, ValueOf, VariableReference, VennExpression, VennPattern, WherePopulated, XPathFunctionCall
public interface ExportAgent
An export agent performs the job of exporting an expression to a SEF file. Normally the expression itself acts as its own export agent, and includes an export() method to do the exporting. In a few cases, notably literals containing function items, extra machinery is required to export a value, and a UserFunctionReference.BoundUserFunction in particular includes custom export methods to handle different cases.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    export(ExpressionPresenter out)
    Diagnostic print of expression structure.

  • Method Details

    • export

      void export(ExpressionPresenter out) throws XPathException
      Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
      Parameters:
      out - the expression presenter used to display the structure
      Throws:
      XPathException - if the export fails, for example if an expression is found that won't work in the target environment.