Package org.apache.unomi.shell.commands

Class ListCommandSupport

java.lang.Object

org.apache.unomi.shell.commands.ListCommandSupport

All Implemented Interfaces:

org.apache.karaf.shell.api.action.Action

Direct Known Subclasses:

ActionList, ConditionList, EventList, EventSearch, ProfileList, RuleList, SegmentList, SessionList

public abstract class ListCommandSupport
extends Object
implements org.apache.karaf.shell.api.action.Action

A utility class to make it easier to build tables for listing Apache Unomi objects.

Constructor Summary

Constructors

Constructor	Description
ListCommandSupport()

Method Summary

Modifier and Type	Method	Description
protected abstract DataTable	buildDataTable()	Build a DataTable object that contains all the data for the object.
Object	execute()
protected abstract String[]	getHeaders()	Returns a String array containing the header names for the table

Methods inherited from class java.lang.Object

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

Constructor Details

ListCommandSupport

public ListCommandSupport()

Method Details

getHeaders

protected abstract String[] getHeaders()

Returns a String array containing the header names for the table

Returns:

a String array with the headers that will be used to render the table

buildDataTable

protected abstract DataTable buildDataTable()

Build a DataTable object that contains all the data for the object. Note that you might want to sort the data inside this method.

Returns:

a populated (and optionally sorted) DataTable object ready to be rendered either as a rendered table or as CSV

execute

public Object execute()
               throws Exception

Specified by:

execute in interface org.apache.karaf.shell.api.action.Action

Throws:

Exception