com.metasolv.nm.processor.MXAggregator

Class MXAggrDispatcher

java.lang.Object

com.metasolv.nm.processor.MXAggregator.MXAggrDispatcher

public class MXAggrDispatcher
extends java.lang.Object

This is a combination of FlexibleAggregatorFieldProcessor and FlexibleAggregatorHandler. Plus other stuff.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dailyFlushFeatureEnabled
protected boolean[]	dailyFlushFlagArray
protected java.util.Timer	dailyFlushTimer
protected FlexibleAggrKeyFactory[]	keyFactoryArray
protected FieldKey	mapChangeTime
protected FieldKey	mapDownlinkVolume
protected FieldKey	mapUplinkVolume
protected FlexibleNARKey[][]	narKeyArray
protected FlexibleAggrTable[][]	tableArray
protected FlexibleTableFlush[][]	tableFlushArray
protected FlexibleTimerFlush[][]	timerFlushArray
static int	TS_DAY
static int	TS_HOUR
static int	TS_MINUTE
static int	TS_MONTH
static int	TS_OFFSET_HOUR
static int	TS_OFFSET_MINUTE
static int	TS_SECOND
static int	TS_SIGN
static int	TS_YEAR Indices into the TimeStamp byte[].

Constructor Summary

Constructors

Constructor and Description
MXAggrDispatcher(DCNode parent, MXNarInputProcessor narInput, DataReceiverIfc narOutput, java.lang.String nplFile, int numThreads)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkDailyFlush(int fpID) Called by MXNarInputProcessor.isDataAvailable(), to do Daily Flush processing.
boolean	compareBytes(DCFieldContainer narA, DCFieldContainer narB, FieldKey attrId) Performs a simple byte comparison on the attribute in the two NARs.
protected DCFieldProcessor	createFieldProcessor(MXJavahookHandler hook) Sets up the general NPLFieldProcesser passing a NAR as the output class for the Field Processor, and passes the NPL file gained from the config for parsing instructions for the NPL.
void	createKey(int index, NAR nar, int fpID) This will generate and return a key based on the record.
boolean	distributeTrafficVolumesPerDay(ListField trafficVolumes, NAR destContainer, java.util.List uplinkVolumeAttrs, java.util.List downlinkVolumeAttrs, ListField unprocessedVolumes, BytesField openingTime) This will distribute the traffic volume uplink and downlink volumes into appropriate daily bins according to the individual times.
byte[]	generateOpeningTimeFromTrafficVolume(java.util.List trafficVolumes) Will return the integer day of year corresponding to the first traffic volume.
protected java.lang.String	generateTableFilename(int th, int tb)
boolean	getAndRemoveNAR(NAR nar, int index, int fpID) This will remove the NAR entry from the table.
java.lang.String	getConfigValue(java.lang.String key)
int	getCount(long tempKey, long tempKey1, long tempKey2, int index) Gets the Count
int	getIntConfigValue(java.lang.String key)
java.util.ArrayList<FlexibleNARKey>	getKeys(NAR nar)
boolean	getNARKeepTimer(NAR nar, int index, int fpID) This will remove a NAR but leave its timer.
long	getVolumeLimit(java.lang.String volume) Converts the string representation of value into long Example: volume is 10KB then returns 10240
protected void	init(int numThreads) Deprecated. Use neoInit(). This method has a bug where records may get trapped in old databases if the number of threads is changed.
void	isAllKeyAttributesExists(NAR nar, int tableNumber)
protected void	neoInit(int numThreads) New initialization to handle numThreads changes between startup.
protected FlexibleAggrTable[][]	openAndReassignAggrTable(int numThreads, int numTables, int compressThreshold) This method will examine the scratch directory for existing aggrtable files.
int	populateIndividualTrafficVolume(java.util.Map trafficVolumeMap, DCFieldContainer destContainer, java.util.List uplinkVolumeIDs, java.util.List downlinkVolumeIDs, BytesField nextOpeningTime, int dayOfYearCheck) Will only populate the traffic volumes if they are for the same day as dayOfYearCheck, unless dayOfYearCheck < 1.
void	printTimer(NAR nar, int index, int fpID) To be used in debugging only.
java.util.LinkedHashMap	readHashMapFromFile(java.io.File file) Reads FlexibleNARTimer objects from the file
void	removeDeactivatedTimer(int index, int fpID) This will remove a deactivated timer.
boolean	removeNAR(int index, int fpID) This will remove a NAR entry from the table without returning the removed entry.
boolean	removeNARTimer(NAR nar, int index, int fpID) This will remove the timer for a NAR from the timer table.
void	removeTimer(NAR nar, int index, int fpID)
void	reset(long cleanup) Reset the Count
void	resetCount(long tempKey, long tempKey1, long tempKey2, int index)
void	resetNarKeys(int fpID)
void	setCount(long tempKey, long tempKey1, long tempKey2, int index) Sets the Count
boolean	setflushTimerActive()
void	shutdown()
protected void	shutdownFieldProcessorThreads()
protected void	startFieldProcessorThreads()
void	storeNAR(NAR nar, int index, boolean setTimer, int fpID) This will generate a key and store the NAR in the table.
void	storeNARReusingTimer(NAR nar, int index, int fpID) This will generate a key and store the NAR in the table with an old timer.

Methods inherited from class java.lang.Object

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

Field Detail

tableArray

protected FlexibleAggrTable[][] tableArray

keyFactoryArray

protected FlexibleAggrKeyFactory[] keyFactoryArray

timerFlushArray

protected FlexibleTimerFlush[][] timerFlushArray

tableFlushArray

protected FlexibleTableFlush[][] tableFlushArray

narKeyArray

protected FlexibleNARKey[][] narKeyArray

dailyFlushFlagArray

protected boolean[] dailyFlushFlagArray

mapChangeTime

protected FieldKey mapChangeTime

mapUplinkVolume

protected FieldKey mapUplinkVolume

mapDownlinkVolume

protected FieldKey mapDownlinkVolume

dailyFlushFeatureEnabled

protected boolean dailyFlushFeatureEnabled

dailyFlushTimer

protected java.util.Timer dailyFlushTimer

TS_YEAR

public static final int TS_YEAR

Indices into the TimeStamp byte[].

See Also:

Constant Field Values

TS_MONTH

public static final int TS_MONTH

See Also:

Constant Field Values

TS_DAY

public static final int TS_DAY

See Also:

Constant Field Values

TS_HOUR

public static final int TS_HOUR

See Also:

Constant Field Values

TS_MINUTE

public static final int TS_MINUTE

See Also:

Constant Field Values

TS_SECOND

public static final int TS_SECOND

See Also:

Constant Field Values

TS_SIGN

public static final int TS_SIGN

See Also:

Constant Field Values

TS_OFFSET_HOUR

public static final int TS_OFFSET_HOUR

See Also:

Constant Field Values

TS_OFFSET_MINUTE

public static final int TS_OFFSET_MINUTE

See Also:

Constant Field Values

Constructor Detail

MXAggrDispatcher

public MXAggrDispatcher(DCNode parent,
                MXNarInputProcessor narInput,
                DataReceiverIfc narOutput,
                java.lang.String nplFile,
                int numThreads)

Method Detail

getConfigValue

public java.lang.String getConfigValue(java.lang.String key)

getIntConfigValue

public int getIntConfigValue(java.lang.String key)

neoInit

protected void neoInit(int numThreads)

New initialization to handle numThreads changes between startup.

Parameters:

numThreads -

readHashMapFromFile

public java.util.LinkedHashMap readHashMapFromFile(java.io.File file)

Reads FlexibleNARTimer objects from the file

Parameters:

file - to read objects from

Returns:

HashMap constructs HashMap with FlexibleNARKey and expiryTime from FlexibleNARTimer objects

setflushTimerActive

public boolean setflushTimerActive()

getVolumeLimit

public long getVolumeLimit(java.lang.String volume)

Converts the string representation of value into long Example: volume is 10KB then returns 10240

Parameters:

volume -

Returns:

long value

openAndReassignAggrTable

protected FlexibleAggrTable[][] openAndReassignAggrTable(int numThreads,
                                             int numTables,
                                             int compressThreshold)

This method will examine the scratch directory for existing aggrtable files. If they exists, and their numbers do not match up with current configured number of threads, then a massive reassignment occurs to put filed records into the new properly-assigned aggrtable, based on the new modulus routing number.

Parameters:

numThreads -

numTables -

Returns:

generateTableFilename

protected java.lang.String generateTableFilename(int th,
                                     int tb)

init

protected void init(int numThreads)

Deprecated. Use neoInit(). This method has a bug where records may get trapped in old databases if the number of threads is changed.

Parameters:

numThreads -

shutdown

public void shutdown()

startFieldProcessorThreads

protected void startFieldProcessorThreads()

shutdownFieldProcessorThreads

protected void shutdownFieldProcessorThreads()

createFieldProcessor

protected DCFieldProcessor createFieldProcessor(MXJavahookHandler hook)
                                         throws NodeProcessingException

Sets up the general NPLFieldProcesser passing a NAR as the output class for the Field Processor, and passes the NPL file gained from the config for parsing instructions for the NPL. This method can be over-ridden by derived classes, if the derived class needs to construct its own field processor with additional information (for example, constructing the FieldProcessor with a IDCMethodHandler object).

Returns:

The DCFieldProcessor that has been configured.

Throws:

NodeProcessingException

checkDailyFlush

protected void checkDailyFlush(int fpID)

Called by MXNarInputProcessor.isDataAvailable(), to do Daily Flush processing.

Parameters:

fpID -

createKey

public void createKey(int index,
             NAR nar,
             int fpID)

This will generate and return a key based on the record.

storeNAR

public void storeNAR(NAR nar,
            int index,
            boolean setTimer,
            int fpID)

This will generate a key and store the NAR in the table.

printTimer

public void printTimer(NAR nar,
              int index,
              int fpID)

To be used in debugging only. Print the time that a NAR will be flushed from the aggregator

storeNARReusingTimer

public void storeNARReusingTimer(NAR nar,
                        int index,
                        int fpID)

This will generate a key and store the NAR in the table with an old timer.

getNARKeepTimer

public boolean getNARKeepTimer(NAR nar,
                      int index,
                      int fpID)

This will remove a NAR but leave its timer.

removeNARTimer

public boolean removeNARTimer(NAR nar,
                     int index,
                     int fpID)

This will remove the timer for a NAR from the timer table. This should be used if the record was removed from the key table, but the timer value was left in the timer table, for example, if getNarSaveTimer was used.

removeTimer

public void removeTimer(NAR nar,
               int index,
               int fpID)

getAndRemoveNAR

public boolean getAndRemoveNAR(NAR nar,
                      int index,
                      int fpID)

This will remove the NAR entry from the table. KY: removed "performance enhancement" by putting synch lock back in.

removeNAR

public boolean removeNAR(int index,
                int fpID)

This will remove a NAR entry from the table without returning the removed entry.

setCount

public void setCount(long tempKey,
            long tempKey1,
            long tempKey2,
            int index)

Sets the Count

getCount

public int getCount(long tempKey,
           long tempKey1,
           long tempKey2,
           int index)

Gets the Count

reset

public void reset(long cleanup)

Reset the Count

resetCount

public void resetCount(long tempKey,
              long tempKey1,
              long tempKey2,
              int index)

removeDeactivatedTimer

public void removeDeactivatedTimer(int index,
                          int fpID)

This will remove a deactivated timer.

distributeTrafficVolumesPerDay

public boolean distributeTrafficVolumesPerDay(ListField trafficVolumes,
                                     NAR destContainer,
                                     java.util.List uplinkVolumeAttrs,
                                     java.util.List downlinkVolumeAttrs,
                                     ListField unprocessedVolumes,
                                     BytesField openingTime)

This will distribute the traffic volume uplink and downlink volumes into appropriate daily bins according to the individual times. If the traffic volumes goes past midnight, it will stop and return false. In this case, the volumes already processed for the previous day will be left processed. The list of traffic volumes will also have the processed volumes removed from the list. Only the unprocessed entries will remain. If no day change is detected, true is returned to indicate all traffic volumes have been processed.

populateIndividualTrafficVolume

public int populateIndividualTrafficVolume(java.util.Map trafficVolumeMap,
                                  DCFieldContainer destContainer,
                                  java.util.List uplinkVolumeIDs,
                                  java.util.List downlinkVolumeIDs,
                                  BytesField nextOpeningTime,
                                  int dayOfYearCheck)

Will only populate the traffic volumes if they are for the same day as dayOfYearCheck, unless dayOfYearCheck < 1. If the same day, that day of the year will be returned. If a different day, 0 will be returned. If no time is provided in the traffic volume map, -1 is returned.

generateOpeningTimeFromTrafficVolume

public byte[] generateOpeningTimeFromTrafficVolume(java.util.List trafficVolumes)

Will return the integer day of year corresponding to the first traffic volume.

compareBytes

public boolean compareBytes(DCFieldContainer narA,
                   DCFieldContainer narB,
                   FieldKey attrId)

Performs a simple byte comparison on the attribute in the two NARs.

isAllKeyAttributesExists

public void isAllKeyAttributesExists(NAR nar,
                            int tableNumber)

getKeys

public java.util.ArrayList<FlexibleNARKey> getKeys(NAR nar)

resetNarKeys

public void resetNarKeys(int fpID)