Package org.javastro.ivoa.entities.stc.v1

Class PolygonType

java.lang.Object

org.javastro.ivoa.entities.stc.v1.StcBaseType

org.javastro.ivoa.entities.stc.v1.CoordIntervalType

org.javastro.ivoa.entities.stc.v1.SpatialIntervalType

org.javastro.ivoa.entities.stc.v1.RegionType

org.javastro.ivoa.entities.stc.v1.ShapeType

org.javastro.ivoa.entities.stc.v1.PolygonType

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class PolygonType
extends ShapeType
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

Polygon: one or more vertices; counter-clockwise (as seen from "inside" or from "top") encircled area is enclosed; sides should span less than 180 deg in each coordinate if spherical; a polygon may not intersect itself

Java class for polygonType complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="polygonType">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}shapeType">
       <sequence>
         <element name="Vertex" type="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}vertexType" maxOccurs="unbounded"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<VertexType>	vertices	In order to form polygons, vertices are to be connected with straight line segments.

Fields inherited from class org.javastro.ivoa.entities.stc.v1.RegionType

area, coordSystemId, note

Fields inherited from class org.javastro.ivoa.entities.stc.v1.SpatialIntervalType

epoch, unit

Fields inherited from class org.javastro.ivoa.entities.stc.v1.CoordIntervalType

fillFactor, frameId, hiInclude, loInclude

Fields inherited from class org.javastro.ivoa.entities.stc.v1.StcBaseType

href, id, idref, idrefType, idType, type, ucd

Constructor Summary

Constructors

Constructor	Description
PolygonType()	Default no-arg constructor
PolygonType(String id, Object idref, String ucd, String type, String href, String idType, String idrefType, Boolean loInclude, Boolean hiInclude, Float fillFactor, Object frameId, BigDecimal epoch, String unit, RegionAreaType area, String note, Object coordSystemId, List<VertexType> vertices)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
List<VertexType>	getVertices()	In order to form polygons, vertices are to be connected with straight line segments.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
String	toString()
PolygonType	withArea(RegionAreaType value)
PolygonType	withCoordSystemId(Object value)
PolygonType	withEpoch(BigDecimal value)
PolygonType	withFillFactor(Float value)
PolygonType	withFrameId(Object value)
PolygonType	withHiInclude(Boolean value)
PolygonType	withHref(String value)
PolygonType	withId(String value)
PolygonType	withIdref(Object value)
PolygonType	withIDREFType(String value)
PolygonType	withIDType(String value)
PolygonType	withLoInclude(Boolean value)
PolygonType	withNote(String value)
PolygonType	withType(String value)
PolygonType	withUcd(String value)
PolygonType	withUnit(String value)
PolygonType	withVertices(Collection<VertexType> values)
PolygonType	withVertices(VertexType... values)

Methods inherited from class org.javastro.ivoa.entities.stc.v1.RegionType

getArea, getCoordSystemId, getNote, setArea, setCoordSystemId, setNote

Methods inherited from class org.javastro.ivoa.entities.stc.v1.SpatialIntervalType

getEpoch, getUnit, setEpoch, setUnit

Methods inherited from class org.javastro.ivoa.entities.stc.v1.CoordIntervalType

getFillFactor, getFrameId, isHiInclude, isLoInclude, setFillFactor, setFrameId, setHiInclude, setLoInclude

Methods inherited from class org.javastro.ivoa.entities.stc.v1.StcBaseType

getHref, getId, getIdref, getIDREFType, getIDType, getType, getUcd, setHref, setId, setIdref, setIDREFType, setIDType, setType, setUcd

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

vertices

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected List<VertexType> vertices

In order to form polygons, vertices are to be connected with straight line segments. In the case of spherical coordinates: greatcircle segments; if a smallCircle element si present, the vertex and its predecessor are to be connected with a smallcircle, by default in the CoordSys that is referenced; optionally, a pole may be specified (other than the CoordSys pole) that defines the smallcircle system

Constructor Details

PolygonType

public PolygonType()

Default no-arg constructor

PolygonType

public PolygonType(String id,
 Object idref,
 String ucd,
 String type,
 String href,
 String idType,
 String idrefType,
 Boolean loInclude,
 Boolean hiInclude,
 Float fillFactor,
 Object frameId,
 BigDecimal epoch,
 String unit,
 RegionAreaType area,
 String note,
 Object coordSystemId,
 List<VertexType> vertices)

Fully-initialising value constructor

Method Details

getVertices

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public List<VertexType> getVertices()

In order to form polygons, vertices are to be connected with straight line segments. In the case of spherical coordinates: greatcircle segments; if a smallCircle element si present, the vertex and its predecessor are to be connected with a smallcircle, by default in the CoordSys that is referenced; optionally, a pole may be specified (other than the CoordSys pole) that defines the smallcircle system Gets the value of the vertices property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the vertices property.

For example, to add a new item, do as follows:

 getVertices().add(newItem);
 

Objects of the following type(s) are allowed in the list VertexType

Returns:

The value of the vertices property.

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class ShapeType

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class ShapeType

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class ShapeType

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

Overrides:

append in class ShapeType

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

Overrides:

appendFields in class ShapeType

withVertices

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withVertices(VertexType... values)

withVertices

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withVertices(Collection<VertexType> values)

withArea

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withArea(RegionAreaType value)

Overrides:

withArea in class ShapeType

withNote

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withNote(String value)

Overrides:

withNote in class ShapeType

withCoordSystemId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withCoordSystemId(Object value)

Overrides:

withCoordSystemId in class ShapeType

withEpoch

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withEpoch(BigDecimal value)

Overrides:

withEpoch in class ShapeType

withUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withUnit(String value)

Overrides:

withUnit in class ShapeType

withLoInclude

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withLoInclude(Boolean value)

Overrides:

withLoInclude in class ShapeType

withHiInclude

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withHiInclude(Boolean value)

Overrides:

withHiInclude in class ShapeType

withFillFactor

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withFillFactor(Float value)

Overrides:

withFillFactor in class ShapeType

withFrameId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withFrameId(Object value)

Overrides:

withFrameId in class ShapeType

withId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withId(String value)

Overrides:

withId in class ShapeType

withIdref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withIdref(Object value)

Overrides:

withIdref in class ShapeType

withUcd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withUcd(String value)

Overrides:

withUcd in class ShapeType

withType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withType(String value)

Overrides:

withType in class ShapeType

withHref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withHref(String value)

Overrides:

withHref in class ShapeType

withIDType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withIDType(String value)

Overrides:

withIDType in class ShapeType

withIDREFType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public PolygonType withIDREFType(String value)

Overrides:

withIDREFType in class ShapeType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class ShapeType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class ShapeType

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

createNewInstance in class ShapeType