com.massa.mrules.action

Class MActionSort

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

com.massa.mrules.action.AbstractBasicAction

com.massa.mrules.action.MActionSort

All Implemented Interfaces:

IAction, IAddon, IMRulesObject, IExecutable, IExecutable.ValueReturning, Outable, Serializable, Cloneable, javax.rules.admin.Rule

@PersistantProperty(property="target") @PersistantProperty(property="asc",defaultValue="true") @PersistantProperty(property="nullFirst",defaultValue="true") @PersistantProperty(property="by") @PersistantProperty(property="inplace",defaultValue="true")
public class MActionSort
extends AbstractBasicAction
implements IExecutable.ValueReturning

Action that sorts the values of the source Accessor.
Sorting is made in place if the target type supports it and if it's requested (default is yes), or to a new collection if not.
Arrays are supported.

Since:

1.10.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.massa.mrules.executable.IExecutable

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_ID

Constructor Summary

Constructors

Constructor and Description
MActionSort()
MActionSort(IReadAccessor target)

Method Summary

Modifier and Type	Method and Description
MActionSort	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
boolean	equals(Object o)
List<IReadAccessor>	getBy()
protected Object	getCol(IExecutionContext ctxt, Object value)
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) This kind of executable should provide a cost estimation in order to be used as accessor and be optimized effectively.
String	getImplementationId() Unique addon implementation ID.
IReadAccessor	getTarget()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
boolean	isAsc()
boolean	isInplace()
boolean	isNullFirst()
void	setAsc(boolean asc)
void	setBy(List<IReadAccessor> by)
void	setInplace(boolean inplace)
void	setNullFirst(boolean nullFirst)
void	setTarget(IReadAccessor target)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.

Methods inherited from class com.massa.mrules.action.AbstractBasicAction

execute

Methods inherited from class com.massa.mrules.executable.AbstractExecutable

combineResults, compile, compileExecutables, execute, execute, getProperties, getProperty, hasProperties, hasProperty, removeProperty, setProperty

Methods inherited from class com.massa.mrules.addon.AbstractAddon

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, toString, wasRegistered

Methods inherited from class com.massa.mrules.base.AbstractMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.mrules.executable.IExecutable

compile, execute, getProperties, hasProperties, hasProperty, removeProperty

Methods inherited from interface com.massa.mrules.addon.IAddon

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

Methods inherited from interface com.massa.mrules.base.IMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from interface javax.rules.admin.Rule

getDescription, getName, getProperty, setProperty

Methods inherited from interface com.massa.mrules.action.IAction

compile

Field Detail

SORT_ID

public static final String SORT_ID

See Also:

Constant Field Values

Constructor Detail

MActionSort

public MActionSort()

MActionSort

public MActionSort(IReadAccessor target)

Method Detail

compileExecutable

protected void compileExecutable(ICompilationContext ctxt)
                          throws MRuleValidationException

Description copied from class: AbstractExecutable

Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.

Specified by:

compileExecutable in class AbstractExecutable

Throws:

MRuleValidationException

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from interface: IExecutable.ValueReturning

This kind of executable should provide a cost estimation in order to be used as accessor and be optimized effectively.

Specified by:

getEstimatedReadCost in interface IExecutable.ValueReturning

Returns:

cost information

Throws:

MRuleValidationException

internalExecute

protected IExecutionResult internalExecute(IExecutionContext ctxt)
                                    throws MActionExecutionException

Specified by:

internalExecute in class AbstractExecutable

Returns:

always OK, as failed execution should raise an exception.

Throws:

MActionExecutionException

See Also:

IAction.execute(IExecutionContext)

getCol

protected Object getCol(IExecutionContext ctxt,
                        Object value)
                 throws UtilsException

Throws:

UtilsException

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

Unique addon implementation ID. In case of conflict, an Class Initialization error will be raised.

Specified by:

getImplementationId in interface IAddon

toString

public void toString(OuterWithLevel outer)
              throws IOException

Description copied from interface: Outable

Method used to send String representation of the current object to the OuterWithLevel.

Specified by:

toString in interface Outable

Throws:

IOException

clone

public MActionSort clone()

Description copied from interface: IAddon

Clones the Addon.
The general contract is that the clone of a compiled Addon is still compiled.

Specified by:

clone in interface IAction

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

Specified by:

clone in interface IExecutable

Overrides:

clone in class AbstractBasicAction

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTarget

public IReadAccessor getTarget()

setTarget

public void setTarget(IReadAccessor target)

isAsc

public boolean isAsc()

setAsc

public void setAsc(boolean asc)

isNullFirst

public boolean isNullFirst()

setNullFirst

public void setNullFirst(boolean nullFirst)

isInplace

public boolean isInplace()

setInplace

public void setInplace(boolean inplace)

getBy

public List<IReadAccessor> getBy()

setBy

public void setBy(List<IReadAccessor> by)