wt.ixb.objectset
Class ObjectSetGeneratorTemplate

java.lang.Object
  wt.ixb.objectset.ObjectSetHandlerTemplate
      wt.ixb.objectset.ObjectSetGeneratorTemplate

All Implemented Interfaces:

ObjectSetGenerator, ObjectSetHandler

Direct Known Subclasses:

GeneralNavigator

public abstract class ObjectSetGeneratorTemplate

extends ObjectSetHandlerTemplate

implements ObjectSetGenerator

Class extends ObjectSetGenerator interface with trivial implementations for most methods.- It can be used by application to make application less dependent of future extension of ObjectSetGenerator interface.

Supported API: true

Extendable: false

Field Summary

private static String	CLASSNAME
private WTContainerRef	containerRef
private static String	RESOURCE

Fields inherited from class wt.ixb.objectset.ObjectSetHandlerTemplate

Fields inherited from interface wt.ixb.objectset.ObjectSetHandler

XML_TAG_DISPLAY, XML_TAG_OBJECT_CREATOR_NAME, XML_TAG_OBJECT_SET_CREATOR, XML_TAG_OBJECT_SET_DIALOG_CLASS_NAME, XML_TAG_OBJECT_SET_HANDLER_CREATOR, XML_TAG_OBJECT_SET_HANDLER_FILTER, XML_TAG_OBJECT_SET_HANDLER_GENERATOR, XML_TAG_OBJECT_SET_HANDLER_HANDLER, XML_TAG_OBJECT_SET_HANDLER_ID, XML_TAG_OBJECT_SET_HANDLER_PARAMETERS, XML_TAG_OBJECT_SET_LOCALIZED_DESCR, XML_TAG_OBJECT_SET_LOCALIZED_MSG_CLASS, XML_TAG_OBJECT_SET_LOCALIZED_MSG_KEY, XML_TAG_OBJECT_SET_LOCALIZED_NAME

Constructor Summary

ObjectSetGeneratorTemplate()

Method Summary

WTContainerRef	getContainerRef() A convenient method to get the WTContainerRef context where the export is launched.
abstract Enumeration	iterate() Iterate the product structure for export.
abstract void	iterate(ObjectVisitor visitor) Iterate the product structure for export.
boolean	iteratePerPage(ObjectVisitor visitor, int pageSize) Iterate the product structure for export.
void	setConfigSpec(ConfigSpec configSpec) Set ConfigSpec for this object set generator.
void	setContainerRef(WTContainerRef containerRef) A convenient method to set the WTContainerRef context where the export is launched.

Methods inherited from class wt.ixb.objectset.ObjectSetHandlerTemplate

getAppletClassName, getClientLocale, getId, getLocalizedDescription, getLocalizedMessageWithoutParams, getLocalizedMessageWithoutParams, getLocalizedMessageWithParams, getLocalizedName, getLocalizedName, getParametersAsString, initialize, setParametersAsString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.ixb.objectset.ObjectSetHandler

getAppletClassName, getId, getLocalizedDescription, getLocalizedName, getLocalizedName, getParametersAsString, initialize, setParametersAsString

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

containerRef

private WTContainerRef containerRef

Constructor Detail

ObjectSetGeneratorTemplate

public ObjectSetGeneratorTemplate()

Method Detail

iterate

public abstract void iterate(ObjectVisitor visitor)
                      throws WTException

Iterate the product structure for export.

Supported API: true

Specified by:

iterate in interface ObjectSetGenerator

Parameters:

visitor -

Throws:

WTException

iterate

public abstract Enumeration iterate()
                             throws WTException

Iterate the product structure for export.

Supported API: true

Specified by:

iterate in interface ObjectSetGenerator

Returns:

Enumeration

Throws:

WTException

iteratePerPage

public boolean iteratePerPage(ObjectVisitor visitor,
                              int pageSize)
                       throws WTException

Iterate the product structure for export. If the number of objects iterated reaches the limit pageSize, do nothing and return.
This method returns true if the number of objects iterated is less than or equal to pageSize and does not need to iterate furthmore.

Supported API: true

Specified by:

iteratePerPage in interface ObjectSetGenerator

Parameters:

visitor -

pageSize -

Returns:

boolean

Throws:

WTException

setContainerRef

public void setContainerRef(WTContainerRef containerRef)

A convenient method to set the WTContainerRef context where the export is launched.

Supported API: true

Specified by:

setContainerRef in interface ObjectSetGenerator

Parameters:

containerRef -

getContainerRef

public WTContainerRef getContainerRef()

A convenient method to get the WTContainerRef context where the export is launched.

Supported API: true

Specified by:

getContainerRef in interface ObjectSetGenerator

Returns:

WTContainerRef

setConfigSpec

public void setConfigSpec(ConfigSpec configSpec)

Set ConfigSpec for this object set generator. This is useful for some cases, especially when the ConfigSpec is not persisted and passed from client directly. Individual implementations of this interface are recommended to implement this method to satisfy their needs.

Supported API: true

Specified by:

setConfigSpec in interface ObjectSetGenerator

Parameters:

configSpec -