org.synchronoss.cpo.jdbc
Class JdbcCpoOrderBy

java.lang.Object
  org.synchronoss.cpo.jdbc.JdbcCpoOrderBy

All Implemented Interfaces:

CpoOrderBy

public class JdbcCpoOrderBy
extends java.lang.Object
implements CpoOrderBy

JdbcCpoOrderBy is an interface for specifying the sort order in which objects are returned from the Datasource.

Author:

david berry

Field Summary

Fields inherited from interface org.synchronoss.cpo.CpoOrderBy

DEFAULT_MARKER

Constructor Summary

JdbcCpoOrderBy(java.lang.String attr, boolean asc)

JdbcCpoOrderBy(java.lang.String attr, boolean asc, java.lang.String func)

JdbcCpoOrderBy(java.lang.String marker, java.lang.String attr, boolean asc)

JdbcCpoOrderBy(java.lang.String marker, java.lang.String attr, boolean asc, java.lang.String func)

Method Summary

boolean	getAscending() Gets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order
java.lang.String	getAttribute() Gets the name of the attribute that is to be used to sort the results from the CpoAdapter.
java.lang.String	getFunction() Gets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting.
java.lang.String	getMarker()
java.lang.String	toString(CpoClass cpoClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcCpoOrderBy

public JdbcCpoOrderBy(java.lang.String attr,
                      boolean asc)

JdbcCpoOrderBy

public JdbcCpoOrderBy(java.lang.String marker,
                      java.lang.String attr,
                      boolean asc)

JdbcCpoOrderBy

public JdbcCpoOrderBy(java.lang.String attr,
                      boolean asc,
                      java.lang.String func)

JdbcCpoOrderBy

public JdbcCpoOrderBy(java.lang.String marker,
                      java.lang.String attr,
                      boolean asc,
                      java.lang.String func)

Method Detail

getAscending

public boolean getAscending()

Gets the boolean that determines if the objects will be returned from from the CpoAdapter in Ascending order or Descending order

Specified by:

getAscending in interface CpoOrderBy

Returns:

boolean true if it is to sort in Ascensing Order false if it is to be sorted in Descending Order

getAttribute

public java.lang.String getAttribute()

Gets the name of the attribute that is to be used to sort the results from the CpoAdapter.

Specified by:

getAttribute in interface CpoOrderBy

Returns:

String The name of the attribute

getFunction

public java.lang.String getFunction()

Gets a string representing a datasource specific function call that must be applied to the attribute that will be used for sorting. i.e. - "upper(attribute_name)"

Specified by:

getFunction in interface CpoOrderBy

Returns:

String The name of the function

toString

public java.lang.String toString(CpoClass cpoClass)
                          throws CpoException

Specified by:

toString in interface CpoOrderBy

Throws:

CpoException

getMarker

public java.lang.String getMarker()

Specified by:

getMarker in interface CpoOrderBy