com.sapportals.wcm.service.indexmanagement.retrieval.search

Class SortPropertyName

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.retrieval.search.SortPropertyName

All Implemented Interfaces:

IName, IPropertyName, ISortPropertyName

public class SortPropertyName

extends Object

implements ISortPropertyName, IPropertyName

A sort property name is a combination of a resource property name and a sort direction.
It is used for sorting documents by one of their properties.

Field Summary

Fields inherited from interface com.sapportals.wcm.service.indexmanagement.retrieval.search.ISortPropertyName

SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

SortPropertyName(IPropertyName propertyName, PropertyType propertyType, boolean sortDirection)

Method Summary

boolean	equals(Object other)
String	getName() Returns the local name.
String	getNamespace() Returns the namespace URI (a missing namespace is mapped to an empty string).
String	getNamespaceOrNull() Returns the namespace URI (a missing namespace is mapped to null).
IPropertyName	getPropertyNameObject() Returns the internal IPropertyName object.
PropertyType	getPropertyType()
boolean	getSortDirection()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SortPropertyName

public SortPropertyName(IPropertyName propertyName,
                        PropertyType propertyType,
                        boolean sortDirection)
                 throws WcmException

Method Detail

getSortDirection

public boolean getSortDirection()

Specified by:

getSortDirection in interface ISortPropertyName

Returns:

if true sort direction is ascending, if false sort direction is descending

getPropertyType

public PropertyType getPropertyType()

Specified by:

getPropertyType in interface ISortPropertyName

Returns:

type of the property

getNamespace

public String getNamespace()

Returns the namespace URI (a missing namespace is mapped to an empty string).

Specified by:

getNamespace in interface IName

Returns:

namespace

getNamespaceOrNull

public String getNamespaceOrNull()

Returns the namespace URI (a missing namespace is mapped to null). Use this function if the value is going to be passed to a XML DOM level 2 method.

Specified by:

getNamespaceOrNull in interface IName

Returns:

namespaceOrNull

getName

public String getName()

Returns the local name.

Specified by:

getName in interface IName

Returns:

name

equals

public boolean equals(Object other)

hashCode

public final int hashCode()

toString

public final String toString()

getPropertyNameObject

public IPropertyName getPropertyNameObject()

Description copied from interface: ISortPropertyName

Returns the internal IPropertyName object.

Specified by:

getPropertyNameObject in interface ISortPropertyName

Returns:

property name