com.endeca.soleng.urlformatter.seo
Class SeoNavStateCanonicalizer

java.lang.Object
  com.endeca.soleng.urlformatter.seo.SeoNavStateCanonicalizer

All Implemented Interfaces:

NavStateCanonicalizer, java.util.Comparator

public class SeoNavStateCanonicalizer
extends java.lang.Object
implements java.util.Comparator, NavStateCanonicalizer

A class that creates a canonical sort order for a NavStateUrlParam.

Property Summary

Property	Type	Default Value
pSortByName	boolean	true
pSortByDimension	boolean	true
pAscending	boolean	true
pIgnoreCase	boolean	true

Constructor Summary

SeoNavStateCanonicalizer()

Method Summary

void	canonicalize(com.endeca.soleng.urlformatter.NavStateUrlParam pNavState)
int	compare(java.lang.Object pObject1, java.lang.Object pObject2)
boolean	equals(java.lang.Object pObject)
boolean	getAscending()
boolean	getIgnoreCase()
boolean	getSortByDimension()
boolean	getSortByName()
void	setAscending(boolean pAscending) Specifies whether or not canonicalization is done in ascending or descending order.
void	setIgnoreCase(boolean pIgnoreCase) Specifies whether or not canonicalization ignores case.
void	setSortByDimension(boolean pSortByDimension) Specifies canonicalization to be done based on Dimension (rather than DimVal).
void	setSortByName(boolean pSortByName) Specifies canonicalization to be done based on the name of the dimension/dimval (rather than ID).

Methods inherited from class java.lang.Object

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

Constructor Detail

SeoNavStateCanonicalizer

public SeoNavStateCanonicalizer()

Method Detail

getSortByName

public boolean getSortByName()

setSortByName

public void setSortByName(boolean pSortByName)

Specifies canonicalization to be done based on the name of the dimension/dimval (rather than ID).

Parameters:

pSortByName - flag indicating whether or not to sort by name (true) or ID (false).

getSortByDimension

public boolean getSortByDimension()

setSortByDimension

public void setSortByDimension(boolean pSortByDimension)

Specifies canonicalization to be done based on Dimension (rather than DimVal).

Parameters:

pSortByDimension - flag indicating whether or not to sort by Dimension (true) or DimVal (false).

getAscending

public boolean getAscending()

setAscending

public void setAscending(boolean pAscending)

Specifies whether or not canonicalization is done in ascending or descending order.

Parameters:

pAscending - flag indicating whether or not to sort ascending (true) or descending (false).

getIgnoreCase

public boolean getIgnoreCase()

setIgnoreCase

public void setIgnoreCase(boolean pIgnoreCase)

Specifies whether or not canonicalization ignores case.

Parameters:

pIgnoreCase - flag indicating whether or not to ignore case. If true, case will be ignored in canoicalization.

canonicalize

public void canonicalize(com.endeca.soleng.urlformatter.NavStateUrlParam pNavState)

Specified by:

canonicalize in interface NavStateCanonicalizer

compare

public int compare(java.lang.Object pObject1,
                   java.lang.Object pObject2)

Specified by:

compare in interface java.util.Comparator

equals

public boolean equals(java.lang.Object pObject)

Specified by:

equals in interface java.util.Comparator

Overrides:

equals in class java.lang.Object