org.caleigo.core
Class EntityCollator

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

All Implemented Interfaces:

java.util.Comparator, java.io.Serializable

public class EntityCollator

extends java.lang.Object

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

The EntityCollator class defines how entities of a defined type should be ordered so that the order information can be relayed. The EntityCollator also implements the Comparartor class making it possible to sort IEntity objects of the defined type in an ISelector or a java.util.list object.

Version:

1.00

Author:

Dennis Zikovic

See Also:

Serialized Form

Nested Class Summary

static class

EntityCollator.FieldCollator

Constructor Summary

EntityCollator(IEntityDescriptor descriptor)
Creates new EntityCollator

EntityCollator(IEntityDescriptor descriptor, EntityCollator collator)

Method Summary

void	addCollationField(EntityCollator.FieldCollator collator)
void	addCollationField(IFieldDescriptor fieldDescriptor)
void	addCollationField(IFieldDescriptor fieldDescriptor, boolean ascending)
void	clearCollatorFields()
int	compare(java.lang.Object obj1, java.lang.Object obj2)
boolean	equals(java.lang.Object data1, java.lang.Object data2)
IEntityDescriptor	getEntityDescriptor()
EntityCollator.FieldCollator	getFieldCollator(int index)
java.util.Iterator	getFieldCollators()
int	getFieldCount()
void	setCollationField(IFieldDescriptor fieldDescriptor)
void	setCollationField(IFieldDescriptor fieldDescriptor, boolean ascending)

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

public EntityCollator(IEntityDescriptor descriptor)

Creates new EntityCollator

EntityCollator

public EntityCollator(IEntityDescriptor descriptor,
                      EntityCollator collator)

Method Detail

compare

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

Specified by:

compare in interface java.util.Comparator

equals

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

setCollationField

public void setCollationField(IFieldDescriptor fieldDescriptor)

setCollationField

public void setCollationField(IFieldDescriptor fieldDescriptor,
                              boolean ascending)

addCollationField

public void addCollationField(IFieldDescriptor fieldDescriptor)

addCollationField

public void addCollationField(IFieldDescriptor fieldDescriptor,
                              boolean ascending)

addCollationField

public void addCollationField(EntityCollator.FieldCollator collator)

clearCollatorFields

public void clearCollatorFields()

getEntityDescriptor

public IEntityDescriptor getEntityDescriptor()

getFieldCount

public int getFieldCount()

getFieldCollator

public EntityCollator.FieldCollator getFieldCollator(int index)

getFieldCollators

public java.util.Iterator getFieldCollators()