SetCursorPositionRequest (OGC OLS NAV 1.3 2.6.0 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.opengis.olsnav.v_1_3
Class SetCursorPositionRequest

java.lang.Object
  net.opengis.ols.v_1_2.AbstractRequestParametersType
      net.opengis.olsnav.v_1_3.SetCursorPositionRequest

All Implemented Interfaces:: Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo2, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.MergeFrom2, org.jvnet.jaxb2_commons.lang.ToString2

public class SetCursorPositionRequest
extends AbstractRequestParametersType
implements Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo2, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.MergeFrom2, org.jvnet.jaxb2_commons.lang.ToString2
extends AbstractRequestParametersType
implements Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo2, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.MergeFrom2, org.jvnet.jaxb2_commons.lang.ToString2

This request positions a large result set cursor current position (CP) to a specified record within the complete result set. The action of this request can be described in two steps as follows, although there is no implication that the actual implementation of the request must be implemented in this way: First, if the "CursorStartPosition" element is RESULT_SET_START, the CP is moved to the gap before the first record; if the "CursorStartPosition" element is RESULT_SET_END, the CP is moved to the gap after the last record; and if the "CursorStartPosition" element is CURRENT_POSITION, the CP is not moved. Second, if NumOfPositions is positive, the CP is moved forward (toward the end of the result set) by NumOfPositions records; if NumOfPositions is negative, the CP is moved backward (toward the beginning of the result set) by NumOfPositions records; if NumOfPositions is zero, the CP is not moved. However, if this movement would move the CP before the gap at the beginning of the large result set or after the gap at the end of the large result set, the CP is instead left at that gap.

Java class for SetCursorPositionRequest complex type.

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

 <complexType name="SetCursorPositionRequest">
   <complexContent>
     <extension base="{http://www.opengis.net/xls}AbstractRequestParametersType">
       <sequence>
         <element name="CursorID" type="{http://www.opengis.net/ols/nav}CursorIDType"/>
         <element name="CursorStartPosition" type="{http://www.opengis.net/ols/nav}CursorOriginEnum"/>
         <element name="NumOfPositions" type="{http://www.w3.org/2001/XMLSchema}long"/>
       </sequence>
       <attribute name="priority" use="required" type="{http://www.opengis.net/ols/nav}PriorityType" />
     </extension>
   </complexContent>
 </complexType>

Field Summary
`protected CursorIDType`	`cursorID`
`protected CursorOriginEnum`	`cursorStartPosition`
`protected long`	`numOfPositions`
`protected int`	`priority`

Constructor Summary
`SetCursorPositionRequest()`

Method Summary
`StringBuilder`	`append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)`
`StringBuilder`	`appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)`
`Object`	`clone()`
`Object`	`copyTo(Object target)`
`Object`	`copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy2 strategy)`
`Object`	`createNewInstance()`
`boolean`	`equals(Object object)`
`boolean`	`equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)`
`CursorIDType`	`getCursorID()` Gets the value of the cursorID property.
`CursorOriginEnum`	`getCursorStartPosition()` Gets the value of the cursorStartPosition property.
`long`	`getNumOfPositions()` Gets the value of the numOfPositions property.
`int`	`getPriority()` Gets the value of the priority property.
`int`	`hashCode()`
`int`	`hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)`
`boolean`	`isSetCursorID()`
`boolean`	`isSetCursorStartPosition()`
`boolean`	`isSetNumOfPositions()`
`boolean`	`isSetPriority()`
`void`	`mergeFrom(org.jvnet.jaxb2_commons.locator.ObjectLocator leftLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb2_commons.lang.MergeStrategy2 strategy)`
`void`	`mergeFrom(Object left, Object right)`
`void`	`setCursorID(CursorIDType value)` Sets the value of the cursorID property.
`void`	`setCursorStartPosition(CursorOriginEnum value)` Sets the value of the cursorStartPosition property.
`void`	`setNumOfPositions(long value)` Sets the value of the numOfPositions property.
`void`	`setPriority(int value)` Sets the value of the priority property.
`String`	`toString()`
`SetCursorPositionRequest`	`withCursorID(CursorIDType value)`
`SetCursorPositionRequest`	`withCursorStartPosition(CursorOriginEnum value)`
`SetCursorPositionRequest`	`withNumOfPositions(long value)`
`SetCursorPositionRequest`	`withPriority(int value)`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

cursorID

protected CursorIDType cursorID

cursorStartPosition

protected CursorOriginEnum cursorStartPosition

numOfPositions

protected long numOfPositions

priority

protected int priority

Constructor Detail