org.apache.jackrabbit.webdav.ordering
Class OrderPatch

java.lang.Object
  extended byorg.apache.jackrabbit.webdav.ordering.OrderPatch
All Implemented Interfaces:
OrderingConstants

public class OrderPatch
extends Object
implements OrderingConstants

OrderPatch represents the mandatory request body of an ORDERPATCH request. RFC 3648 defines the following structure for it:

 <!ELEMENT orderpatch (ordering-type?, order-member*) >
 <!ELEMENT order-member (segment, position) >
 <!ELEMENT position (first | last | before | after) >
 <!ELEMENT segment (#PCDATA) >
 <!ELEMENT first EMPTY >
 <!ELEMENT last EMPTY >
 <!ELEMENT before segment >
 <!ELEMENT after segment >
 


Nested Class Summary
 class OrderPatch.Member
          Internal class Member represents the 'Order-Member' children elements of an 'OrderPatch' request body present in the ORDERPATCH request.
 
Field Summary
 
Fields inherited from interface org.apache.jackrabbit.webdav.ordering.OrderingConstants
HEADER_ORDERING_TYPE, HEADER_POSITION, ORDERING_TYPE, ORDERING_TYPE_CUSTOM, ORDERING_TYPE_UNORDERED, SUPPORTED_LIVE_PROPERTY_SET, SUPPORTED_METHOD_SET, XML_AFTER, XML_BEFORE, XML_FIRST, XML_LAST, XML_ORDER_MEMBER, XML_ORDERING_TYPE, XML_ORDERPATCH, XML_POSITION, XML_SEGMENT
 
Constructor Summary
OrderPatch(org.jdom.Element orderPatchElement)
          Create a new OrderPath object.
OrderPatch(String orderingType, OrderPatch.Member[] instructions)
          Create a new OrderPath object.
 
Method Summary
 String getOrderingType()
          Return the ordering type.
 OrderPatch.Member[] getOrderInstructions()
          Return an array of OrderPatch.Member objects defining the re-ordering instructions to be applied to the requested resource.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrderPatch

public OrderPatch(org.jdom.Element orderPatchElement)
Create a new OrderPath object.

Parameters:
orderPatchElement -
Throws:
IllegalArgumentException - if the specified Xml element was not valid.

OrderPatch

public OrderPatch(String orderingType,
                  OrderPatch.Member[] instructions)
Create a new OrderPath object.

Parameters:
orderingType -
instructions -
Method Detail

getOrderingType

public String getOrderingType()
Return the ordering type.

Returns:
ordering type

getOrderInstructions

public OrderPatch.Member[] getOrderInstructions()
Return an array of OrderPatch.Member objects defining the re-ordering instructions to be applied to the requested resource.

Returns:
ordering instructions.


Copyright © 2005 . All Rights Reserved.