Class LocationType


  • public class LocationType
    extends java.lang.Object
    Represents the value of an Apama location type, consisting of of two (x,y) co-ordinates. The associated type is represented by LocationFieldType.TYPE.

    Values of the location type describe rectangular areas in a two-dimensional unit-less Cartesian coordinate plane. Locations are defined by the float coordinates of two points x1, y1 and x2, y2 at diagonally opposite corners of an enclosing boundary rectangle.

    • Constructor Summary

      Constructors 
      Constructor Description
      LocationType()
      Construct a new instance of LocationType, with coordinates initialized to 0.0.
      LocationType​(double x1, double y1, double x2, double y2)
      Construct a new instance of LocationType, with input coordinates as constructor arguments.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getX1()
      Returns the x component of the first point that describes the rectangular area.
      double getX2()
      Returns the x component of the second point that describes the rectangular area.
      double getY1()
      Returns the y component of the first point that describes the rectangular area.
      double getY2()
      Returns the y component of the second point that describes the rectangular area.
      java.lang.String toString()
      Returns the x component of the first point that describes the rectangular area.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LocationType

        public LocationType​(double x1,
                            double y1,
                            double x2,
                            double y2)
        Construct a new instance of LocationType, with input coordinates as constructor arguments.
      • LocationType

        public LocationType()
        Construct a new instance of LocationType, with coordinates initialized to 0.0.
    • Method Detail

      • getX1

        public double getX1()
        Returns the x component of the first point that describes the rectangular area.
      • getX2

        public double getX2()
        Returns the x component of the second point that describes the rectangular area.
      • getY1

        public double getY1()
        Returns the y component of the first point that describes the rectangular area.
      • getY2

        public double getY2()
        Returns the y component of the second point that describes the rectangular area.
      • toString

        public java.lang.String toString()
        Returns the x component of the first point that describes the rectangular area.
        Overrides:
        toString in class java.lang.Object