org.caleigo.core
Class EntityCollator.FieldCollator

java.lang.Object
  org.caleigo.core.EntityCollator.FieldCollator

All Implemented Interfaces:

java.util.Comparator, java.io.Serializable

Enclosing class:

EntityCollator

public static class EntityCollator.FieldCollator

extends java.lang.Object

implements java.util.Comparator, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor)

EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor, boolean ascending)

EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor, boolean ascending, java.text.Collator stringCollator)
Note that the string collator will only be accepted if the fields data class is String.

Method Summary

int	compare(java.lang.Object obj1, java.lang.Object obj2) Note that the compare method in the FieldCollator object is required to handle both the data type of the field and entity objects as parameter values.
boolean	equals(java.lang.Object data1, java.lang.Object data2)
IFieldDescriptor	getFieldDescriptor()
java.text.Collator	getStringCollator()
boolean	isAscending()

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

EntityCollator.FieldCollator

public EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor)

EntityCollator.FieldCollator

public EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor,
                                    boolean ascending)

EntityCollator.FieldCollator

public EntityCollator.FieldCollator(IFieldDescriptor fieldDescriptor,
                                    boolean ascending,
                                    java.text.Collator stringCollator)

Note that the string collator will only be accepted if the fields data class is String.

Method Detail

compare

public int compare(java.lang.Object obj1,
                   java.lang.Object obj2)

Note that the compare method in the FieldCollator object is required to handle both the data type of the field and entity objects as parameter values. If the parameters are IEntity objects then the field collator chould extract the field data it is designed to collate and use that data in itīs comparison.

Specified by:

compare in interface java.util.Comparator

equals

public boolean equals(java.lang.Object data1,
                      java.lang.Object data2)

getFieldDescriptor

public IFieldDescriptor getFieldDescriptor()

isAscending

public boolean isAscending()

getStringCollator

public java.text.Collator getStringCollator()