org.snmp4j.agent.mo.MOTableRelation Maven / Gradle / Ivy
/*_############################################################################
_##
_## SNMP4J-Agent - MOTableRelation.java
_##
_## Copyright (C) 2005-2009 Frank Fock (SNMP4J.org)
_##
_## Licensed under the Apache License, Version 2.0 (the "License");
_## you may not use this file except in compliance with the License.
_## You may obtain a copy of the License at
_##
_## http://www.apache.org/licenses/LICENSE-2.0
_##
_## Unless required by applicable law or agreed to in writing, software
_## distributed under the License is distributed on an "AS IS" BASIS,
_## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
_## See the License for the specific language governing permissions and
_## limitations under the License.
_##
_##########################################################################*/
package org.snmp4j.agent.mo;
import org.snmp4j.smi.OID;
/**
* The MOTableRelation class models table relations like sparse
* table relationship and augmentation. This class implements the augmentation
* relationship. In order to implement a sparse table relationship, sub-classing
* MOTableRelation is needed and the methods
* {@link #hasDependentRow} and {@link #getDependentIndexes} must be overwritten
* then.
*
* @author Frank Fock
* @version 1.0
*/
public class MOTableRelation {
private MOTable baseTable;
private MOTable dependentTable;
/**
* Creates a table relation from a base table and the dependent table.
* To actually set up the relationship between those tables
* {@link #createRelationShip()} needs to be called.
*
* @param baseTable
* the base table.
* @param dependentTable
* the dependent (augmenting) table.
*/
public MOTableRelation(MOTable baseTable, MOTable dependentTable) {
this.baseTable = baseTable;
this.dependentTable = dependentTable;
}
/**
* Actually sets up the relationship between base and dependent table by
* adding this instance as row listener to the base table.
*/
public void createRelationShip() {
this.baseTable.addMOTableRowListener(createRelationShipListener());
}
protected MOTableRowListener createRelationShipListener() {
return new RelationShipListener();
}
/**
* Indicates whether the specified baseTableRow has any dependent rows.
* By default this method returns true because the default
* implementation represents an augmentation relationship.
* Overwrite this method in a sub-class to implement a sparse table
* relationship.
* @param baseTableRow
* a row of the base table.
* @return
* true if the row has dependent rows.
*/
public boolean hasDependentRow(MOTableRow baseTableRow) {
// by default this is an augmentation
// overwrite in a subclass to implement sparse relationship
return true;
}
/**
* Returns the dependent indexes for the specified base row. By default, this
* method returns the base rows index in a one element array, because
* the default implementation represents an augmentation relationship.
* Overwrite this method in a sub-class to implement a sparse table
* relationship.
* @param baseRow
* a row of the base table.
* @return
* an array of row index values of the dependent rows.
*/
public OID[] getDependentIndexes(MOTableRow baseRow) {
// by default this is an augmentation
// overwrite in a subclass to implement sparse relationship
return new OID[] { baseRow.getIndex() };
}
/**
* Adds all dependent rows for the specified base table row to the dependent
* table. This method is automatically called if {@link #createRelationShip()}
* has been called.
*
* @param baseTableRow
* a row of the base table.
*/
protected void addDependentRows(MOTableRow baseTableRow) {
OID[] indexes = getDependentIndexes(baseTableRow);
for (int i=0; i