net.sf.jso.query
Class FieldOrder

java.lang.Object
  extended bynet.sf.jso.query.Order
      extended bynet.sf.jso.query.FieldOrder
All Implemented Interfaces:
java.io.Serializable

public class FieldOrder
extends Order
implements java.io.Serializable

A small order expression composed of a variable, a field and an order operator.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.jso.query.Order
elements
 
Constructor Summary
FieldOrder()
          Constructs order field.
FieldOrder(java.lang.String aField)
          Constructs order.
FieldOrder(java.lang.String aField, OrderOperator anOperator)
          Constructs order.
FieldOrder(Variable aVariable, java.lang.String aField, OrderOperator anOperator)
          Constructs order.
 
Method Summary
 void addOrder(java.util.Collection someOrder)
          Not supported.
 void addOrder(Order someOrder)
          Not supported.
 java.util.List getElements()
          Not supported.
 java.lang.String getField()
          Returns order's field.
 OrderOperator getOperator()
          Returns order's operator.
 Variable getVariable()
          Returns order's variable.
 boolean isEmpty()
          Indicates if the all order information has been specified.
 void setField(java.lang.String aField)
          Sets order's field.
 void setOperator(OrderOperator anOperator)
          Sets order's operator.
 void setVariable(Variable aVariable)
          Sets order's variable.
 int size()
          Returns the number of elements of the order.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldOrder

public FieldOrder()
Constructs order field.


FieldOrder

public FieldOrder(Variable aVariable,
                  java.lang.String aField,
                  OrderOperator anOperator)
Constructs order.

Parameters:
aVariable - Order's variable.
aField - Order's field.
anOperator - Order's operator.

FieldOrder

public FieldOrder(java.lang.String aField,
                  OrderOperator anOperator)
Constructs order. Order's variable will be set to parameter's first variable.

Parameters:
aField - Order's field.
anOperator - Order's operator.
See Also:
Parameters.variables

FieldOrder

public FieldOrder(java.lang.String aField)
Constructs order. Order's variable will be set to parameter's first variable and order's operator will be set to ASCENDING.

Parameters:
aField - Order's field.
See Also:
Parameters.variables, OrderOperator.ASCENDING
Method Detail

getField

public java.lang.String getField()
Returns order's field.

Returns:
order's field.

setField

public void setField(java.lang.String aField)
Sets order's field.

Parameters:
aField - Order's field.

getOperator

public OrderOperator getOperator()
Returns order's operator.

Returns:
order's operator.

setOperator

public void setOperator(OrderOperator anOperator)
Sets order's operator.

Parameters:
anOperator - Order's operator.

getVariable

public Variable getVariable()
Returns order's variable.

Returns:
order's variable.

setVariable

public void setVariable(Variable aVariable)
Sets order's variable.

Parameters:
aVariable - Order's variable.

addOrder

public void addOrder(java.util.Collection someOrder)
Not supported.

Overrides:
addOrder in class Order
Parameters:
someOrder - Collection of order to be added.
Throws:
java.lang.UnsupportedOperationException - Always.

addOrder

public void addOrder(Order someOrder)
Not supported.

Overrides:
addOrder in class Order
Parameters:
someOrder - Order to be added.
Throws:
java.lang.UnsupportedOperationException - Always.

getElements

public java.util.List getElements()
Not supported.

Overrides:
getElements in class Order
Returns:
null

isEmpty

public boolean isEmpty()
Indicates if the all order information has been specified.

Overrides:
isEmpty in class Order
Returns:
true if order's variable, field or operator has not been specified; false if all information has been set.

size

public int size()
Returns the number of elements of the order.

Overrides:
size in class Order
Returns:
Always returns 1.