[SEDONA-186] Fix ordering of columns in results of queries like SELECT * A JOIN B

[Kontinuation]

Did you read the Contributor Guide?

• Yes, I have read Contributor Rules and Contributor Development Guide

Is this PR related to a JIRA ticket?

• Yes, the URL of the assoicated JIRA ticket is https://issues.apache.org/jira/browse/SEDONA-186

What changes were proposed in this PR?

Fixes SEDONA-186 by properly assembling result rows of join queries when left and right sub plans were swapped.

How was this patch tested?

New tests were added to SpatialJoinSuite.

Did this PR include necessary documentation updates?

• No, this PR does not affect any public API so no need to change the docs.

[Kimahriman]

Can these just be handled like the broadcast join below where the swapping is handled here with pattern matching instead of pushed into the Exec node?

[Kontinuation]

Exec node has to handle the swapping somewhere, unless we invert the spatial predicate in the join query detector.

Broadcast join exec node resolves if left and right were swapped using indexBuildSide and windowJoinSide, it does not seem to be more intuitive than simply pushing the swapping indicator to the TraitJoinQueryExec node.

Inverting the spatial predicate seems to be a viable approach, I'll submit changes to this PR if you're OK with it.

[jiayuasu]

@Kimahriman Adam, does @Kontinuation 's approach "Inverting the spatial predicate" sound good to you? :-)

[Kimahriman]

I'm trying to wrap my head around this a little bit. By inverting the spatial predicate do you mean like rewritting it? As in ST_Contains(a, b) -> ST_Within(b, a) or something like that?

What would happen if you just swapped the left and right shapes if needed? Like

    matchExpressionsToPlans(a, b, left, right) match {
      case Some((_, _, swapped)) =>
        logInfo(s"Planning spatial join for $relationship relationship")
        if (swapped) {
          RangeJoinExec(planLater(left), planLater(right), b, a, spatialPredicate, extraCondition) :: Nil
        } else {
          RangeJoinExec(planLater(left), planLater(right), a, b, spatialPredicate, extraCondition) :: Nil
        }
      case None =>
        logInfo(
          s"Spatial join for $relationship with arguments not aligned " +
            "with join relations is not supported")
        Nil
    }

I'm trying to think of why that wouldn't work

[jiayuasu]

@Kontinuation I will merge this PR for now since we will release 1.3.0 in the next few days. Maybe we can address @Kimahriman 's comment in another PR.