com.sapportals.wcm.service.propertyconfig.comparator
Class PropertyLanguageDependingComparator

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertyconfig_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.service.propertyconfig.comparator.PropertyLanguageDependingComparator

All Implemented Interfaces:

java.util.Comparator, IResourcePropertyComparator

public class PropertyLanguageDependingComparator

extends java.lang.Object

implements IResourcePropertyComparator

Default implementation of a resource property comparator. It is used if no other comparator is configured for a property.

Constructor Summary

PropertyLanguageDependingComparator(IMetaName sortPropertyName, int sortMode, boolean useDisplayNameAsSecondProperty)

Method Summary

int	compare(java.lang.Object o1, java.lang.Object o2)
int	getSortMode() Current sort mode for sorting resource properties.
IMetaName	getSortPropertyName() Name of the property that is used for sorting.
void	setSortMode(int sortMode) Determines the sort mode of the resource properties.
void	setSortParameters(IMetaName sortPropertyName, int sortMode) Name of the property that is used for sorting and the default sort mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

PropertyLanguageDependingComparator

public PropertyLanguageDependingComparator(IMetaName sortPropertyName,
                                           int sortMode,
                                           boolean useDisplayNameAsSecondProperty)

Method Detail

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Specified by:

compare in interface java.util.Comparator

See Also:

Comparator

setSortMode

public void setSortMode(int sortMode)
                 throws PropertyConfigurationServiceException

Determines the sort mode of the resource properties. Use constants IMetaName.SORTMODE_ASCENDING and IMetaName.SORTMODE_DESCENDING. Default is defined in the meta data of the property.

Specified by:

setSortMode in interface IResourcePropertyComparator

Parameters:

sortMode - order of sorting for property values

getSortMode

public int getSortMode()

Current sort mode for sorting resource properties. Compare with constants IMetaName.SORTMODE_ASCENDING and IMetaName.SORTMODE_DESCENDING

Specified by:

getSortMode in interface IResourcePropertyComparator

Returns:

sort mode of the comparator

getSortPropertyName

public IMetaName getSortPropertyName()

Name of the property that is used for sorting.

Specified by:

getSortPropertyName in interface IResourcePropertyComparator

Returns:

property name for sorting

setSortParameters

public void setSortParameters(IMetaName sortPropertyName,
                              int sortMode)
                       throws PropertyConfigurationServiceException

Name of the property that is used for sorting and the default sort mode. The parameters are set internally by the property configuration service.

Specified by:

setSortParameters in interface IResourcePropertyComparator

Parameters:

sortPropertyName - property name for sorting

sortMode - order of sorting for property values