Package org.ivoa.dm.proposal.prop

Class Polygon

java.lang.Object
org.ivoa.dm.proposal.prop.Field
org.ivoa.dm.proposal.prop.Polygon
All Implemented Interfaces:
org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="proposal:Polygon", role=objectType) public class Polygon extends Field implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>, org.ivoa.vodml.jaxb.XmlIdManagement
Polygonal map. objectType: Polygon

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Polygon.PolygonBuilder
    A builder class for Polygon, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected List<org.ivoa.dm.stc.coords.EquatorialPoint>
    points
    an array of points....

    Fields inherited from class org.ivoa.dm.proposal.prop.Field

    _id, name

  • Constructor Summary

    Constructors
    Constructor
    Description
    Polygon()
    Creates a new Polygon
    Polygon(List<org.ivoa.dm.stc.coords.EquatorialPoint> points, String name)
    full parameter constructor.
    Polygon(Field superinstance, List<org.ivoa.dm.stc.coords.EquatorialPoint> points)
    Constructor from supertype instance.
    Polygon(Polygon other)
    Copy Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Field
    copyMe()
    make a clone of the object taking into account current polymorhic type.
    static Polygon
    createPolygon(Consumer<Polygon.PolygonBuilder> f)
    create a Polygon in functional builder style.
    void
    forceLoad()
     
    List<org.ivoa.dm.stc.coords.EquatorialPoint>
    getPoints()
    Returns points Attribute.
    void
    persistRefs(jakarta.persistence.EntityManager _em)
    Deprecated.
    generally better to use the model level reference persistence as only this can deal with "contained" references properly.
    void
    setPoints(List<org.ivoa.dm.stc.coords.EquatorialPoint> pPoints)
    Set points Attribute.
    void
    updateUsing(Polygon other)
    Update this object with the content of the given object.
    Polygon
    withPoints(List<org.ivoa.dm.stc.coords.EquatorialPoint> pPoints)
    fluent setter for points Attribute.

    Methods inherited from class org.ivoa.dm.proposal.prop.Field

    getId, getName, getXmlId, hasNaturalKey, setName, setXmlId, updateUsing, withName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

    getId

    Methods inherited from interface org.ivoa.vodml.jaxb.XmlIdManagement

    getXmlId, hasNaturalKey, setXmlId

  • Field Details

    • points

      @VoDml(id="proposal:Polygon.points", role=attribute, type="coords:EquatorialPoint", typeRole=dataType) protected List<org.ivoa.dm.stc.coords.EquatorialPoint> points
      an array of points.... : Attribute points : multiplicity 0..*

  • Constructor Details

    • Polygon

      public Polygon()
      Creates a new Polygon

    • Polygon

      public Polygon(List<org.ivoa.dm.stc.coords.EquatorialPoint> points, String name)
      full parameter constructor.
      Parameters:
      points - an array of points....
      name - .

    • Polygon

      public Polygon(Polygon other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • Polygon

      public Polygon(Field superinstance, List<org.ivoa.dm.stc.coords.EquatorialPoint> points)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      points - an array of points....

  • Method Details

    • copyMe

      public Field copyMe()
      make a clone of the object taking into account current polymorhic type.
      Specified by:
      copyMe in class Field
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(Polygon other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getPoints

      public List<org.ivoa.dm.stc.coords.EquatorialPoint> getPoints()
      Returns points Attribute.
      Returns:
      points Attribute

    • setPoints

      public void setPoints(List<org.ivoa.dm.stc.coords.EquatorialPoint> pPoints)
      Set points Attribute.
      Parameters:
      pPoints - value to set

    • withPoints

      public Polygon withPoints(List<org.ivoa.dm.stc.coords.EquatorialPoint> pPoints)
      fluent setter for points Attribute.
      Parameters:
      pPoints - value to set
      Returns:
      Polygon

    • createPolygon

      public static Polygon createPolygon(Consumer<Polygon.PolygonBuilder> f)
      create a Polygon in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      forceLoad in class Field

    • persistRefs

      @Deprecated public void persistRefs(jakarta.persistence.EntityManager _em)
      Deprecated.
      generally better to use the model level reference persistence as only this can deal with "contained" references properly.
      Specified by:
      persistRefs in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      persistRefs in class Field