public abstract class Handler
extends java.lang.Object
| Constructor and Description |
|---|
Handler() |
| Modifier and Type | Method and Description |
|---|---|
abstract TableBean<? extends TableData> |
create(HandlerCtx ctx)
This method is invoked both when the XBL is being created and during
comparison when an already created XBL is being compared with a live
structure.
|
TableBeanInfo |
getAdditionalData(HandlerCtx ctx,
java.lang.String id)
Processes a particular section.
|
java.lang.String[] |
getAdditionalSectionIds(HandlerCtx ctx)
Subclasses can specify additional sections to be included in the XBL.
|
Statement[] |
getAdditionalSelectables(BaselineConfig cfg,
boolean forRel)
Enables subclasses to provide the
XBL serializer
with more select statements that results in more data
being serialized into the XBL/XML data. |
TableBean<?> |
getConnectData(HandlerCtx ctx)
If the baseline supports edit, you can override this method in order to
specify what data to be included when the user performs a connect or
replace operation.
|
public abstract TableBean<? extends TableData> create(HandlerCtx ctx) throws TVCException
The purpose is to create a TableBean that holds the objects and
connections that are supposed to be serialized down to the XBL/XML data.
Note: This method returns a TableBean. The normal usage of the
XBL is that this method should return an instance of
StructureBean (which is a sub-interface to the TableBean). This
is because the Comparison feature can only do comparisons between two
structure beans.
ctx - The contextTableBeanTVCException - If any errors occurs that are unrecoverablepublic java.lang.String[] getAdditionalSectionIds(HandlerCtx ctx)
Return an array of strings that represents each section. You will later
need to implement the getAdditionalData(HandlerCtx, String)
method that is responsible for returning the data related to a particular
section.
ctx - The contextpublic TableBeanInfo getAdditionalData(HandlerCtx ctx, java.lang.String id) throws TVCException
ctx - The HandlerCtxid - The ID of the section.TVCException - If any errors occurs that are unrecoverablepublic TableBean<?> getConnectData(HandlerCtx ctx) throws TVCException
ctx - The HandlerCtxTableBeanTVCExceptionpublic Statement[] getAdditionalSelectables(BaselineConfig cfg, boolean forRel)
XBL serializer
with more select statements that results in more data
being serialized into the XBL/XML data.
This method returns null by default.
cfg - The current configforRel - True if you should return selectables that applies to
relationships, otherwise false.statements. Null is an allowed
return value.Copyright ? Technia AB. All Rights Reserved.