net.sf.letsparty.cfg
Interface PartitionedTable

All Known Implementing Classes:
BasicPartitionedTable

public interface PartitionedTable

Corresponds to an <table> element in the configuration.


Method Summary
 void addPartitionedColumn(PartitionedColumn partitionedColumn)
          Called by the configuration builder
 void fillPartitionedTableListNullSuffixes(PartitionedTableSuffixList partitionedTableSuffixList)
          Fill the column null suffixes with all the partitions of the column (for each null column suffix).
 java.lang.String getName()
           
 PartitionedColumn getPartitionedColumn(java.lang.String name)
           
 int getPartitionedColumnIndex(PartitionedColumn partitionedColumn)
           
 java.util.List getPartitionedColumns()
          Returns the list of all the partitioned columns of this table.
 java.lang.String getPartitionedTableNameFromSuffixes(java.lang.String[] suffixes)
          Constructs a table name given a list of column suffixes.
 java.util.List getPartitionedTables(PartitionedTableSuffixList partitionedTableSuffixList)
          A list of table names built using partitionedTableSuffixList
 PartitionedTableSuffixList getPartitionedTableSuffixList()
          Returns a PartitionedTableSuffixList with all the partitions of all the columns.
 void setName(java.lang.String name)
          Called by the configuration builder
 void setSeparator(java.lang.String separator)
          Called by the configuration builder
 

Method Detail

getPartitionedTableSuffixList

public PartitionedTableSuffixList getPartitionedTableSuffixList()
                                                         throws LetsPartyException
Returns a PartitionedTableSuffixList with all the partitions of all the columns.

Returns:
a PartitionedTableSuffixList with all the partitions of all the columns.
Throws:
LetsPartyException

fillPartitionedTableListNullSuffixes

public void fillPartitionedTableListNullSuffixes(PartitionedTableSuffixList partitionedTableSuffixList)
                                          throws LetsPartyException
Fill the column null suffixes with all the partitions of the column (for each null column suffix).

Throws:
LetsPartyException

getPartitionedColumn

public PartitionedColumn getPartitionedColumn(java.lang.String name)
Parameters:
name -
Returns:
the PartitionedColumn named name

getPartitionedColumnIndex

public int getPartitionedColumnIndex(PartitionedColumn partitionedColumn)
                              throws LetsPartyException
Returns:
the index of the partitionedColumn in this table
Throws:
LetsPartyException

getPartitionedTableNameFromSuffixes

public java.lang.String getPartitionedTableNameFromSuffixes(java.lang.String[] suffixes)
                                                     throws LetsPartyException
Constructs a table name given a list of column suffixes. Example: if suffixes are {"A", "1"} and partitioned table name is "MYTAB" and separator is "_" returns "MYTAB_A_1"

Parameters:
suffixes -
Returns:
a table name
Throws:
LetsPartyException

getPartitionedTables

public java.util.List getPartitionedTables(PartitionedTableSuffixList partitionedTableSuffixList)
                                    throws LetsPartyException
A list of table names built using partitionedTableSuffixList

Parameters:
partitionedTableSuffixList -
Returns:
a list of Strings
Throws:
LetsPartyException

addPartitionedColumn

public void addPartitionedColumn(PartitionedColumn partitionedColumn)
Called by the configuration builder

Parameters:
partitionedColumn -

setName

public void setName(java.lang.String name)
Called by the configuration builder

Parameters:
name -

getName

public java.lang.String getName()

setSeparator

public void setSeparator(java.lang.String separator)
Called by the configuration builder

Parameters:
separator -

getPartitionedColumns

public java.util.List getPartitionedColumns()
Returns the list of all the partitioned columns of this table.