com.technia.tvc.xbom.xbl2

Class Handler

java.lang.Object

com.technia.tvc.xbom.xbl2.Handler

Direct Known Subclasses:

DefaultHandler

public abstract class Handler
extends java.lang.Object

A handler can be used to customize how and what data to be included within a generate XBL.

Since:

2009.3.0

Constructor Summary

Constructors

Constructor and Description
Handler()

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Handler

public Handler()

Method Detail

create

public abstract TableBean<? extends TableData> create(HandlerCtx ctx)
                                               throws TVCException

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. In the latter case, this method is used in order to create the same type of data as if the XBL were created.

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.

Parameters:

ctx - The context

Returns:

A TableBean

Throws:

TVCException - If any errors occurs that are unrecoverable

Since:

2009.3.0

getAdditionalSectionIds

public java.lang.String[] getAdditionalSectionIds(HandlerCtx ctx)

Subclasses can specify additional sections to be included in the XBL.

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.

Parameters:

ctx - The context

Returns:

A string array of ID's (null is of course allowed in case you don't want any additional sections to be included).

Since:

2010.3.0

getAdditionalData

public TableBeanInfo getAdditionalData(HandlerCtx ctx,
                              java.lang.String id)
                                throws TVCException

Processes a particular section.

Parameters:

ctx - The HandlerCtx

id - The ID of the section.

Throws:

TVCException - If any errors occurs that are unrecoverable

Since:

2010.3.0

getConnectData

public TableBean<?> getConnectData(HandlerCtx ctx)
                            throws TVCException

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.

Parameters:

ctx - The HandlerCtx

Returns:

A TableBean

Throws:

TVCException

Since:

2010.3.0

getAdditionalSelectables

public 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.

This method returns null by default.

Parameters:

cfg - The current config

forRel - True if you should return selectables that applies to relationships, otherwise false.

Returns:

An array of statements. Null is an allowed return value.

Since:

2010.3.0