com.ptc.windchill.esi.bom
Class BOMRendererFactory

java.lang.Object
  extended bycom.ptc.windchill.esi.bom.BOMRendererFactory
All Implemented Interfaces:
Externalizable, Serializable

public final class BOMRendererFactory
extends Object
implements Externalizable

Provides methods to obtain the correct instance of the renderers that create BOM output.

Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
protected static ESIPropertyRequest BOM_COMPONENT_RENDERER
           
protected static ESIPropertyRequest BOM_HEADER_RENDERER
           
protected static ESIPropertyRequest BOM_ORG_FILTER
           
protected static ESIPropertyRequest BOM_RENDERER
           
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
protected static ESIPropertyRequest REFERENCE_DESIGNATOR_RENDERER
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
protected static ESIPropertyRequest SUBSTITUTE_RENDERER
           
 
Constructor Summary
BOMRendererFactory()
           
 
Method Summary
static BOMComponentRenderer newBOMComponentRenderer()
          Returns an instance of the appropriate implementation of BOMComponentRenderer.
static BOMHeaderRenderer newBOMHeaderRenderer()
          Returns an instance of the appropriate implementation of BOMHeaderRenderer.
static BOMOrgFilter newBOMOrgFilter()
          Returns an instance of BOMOrgFilter (or an appropriate subclass).
static BOMRenderer newBOMRenderer()
          Returns an instance of the appropriate implementation of BOMRenderer.
private static Object newObjectFromProperty(ESIPropertyRequest property)
           
static ReferenceDesignatorRenderer newReferenceDesignatorRenderer()
          Returns an instance of the appropriate implementation of ReferenceDesignatorRenderer.
static SubstituteRenderer newSubstituteRenderer()
          Returns an instance of the appropriate implementation of SubstituteRenderer.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(BOMRendererFactory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values

BOM_ORG_FILTER

protected static final ESIPropertyRequest BOM_ORG_FILTER

BOM_RENDERER

protected static final ESIPropertyRequest BOM_RENDERER

BOM_HEADER_RENDERER

protected static final ESIPropertyRequest BOM_HEADER_RENDERER

BOM_COMPONENT_RENDERER

protected static final ESIPropertyRequest BOM_COMPONENT_RENDERER

SUBSTITUTE_RENDERER

protected static final ESIPropertyRequest SUBSTITUTE_RENDERER

REFERENCE_DESIGNATOR_RENDERER

protected static final ESIPropertyRequest REFERENCE_DESIGNATOR_RENDERER
Constructor Detail

BOMRendererFactory

public BOMRendererFactory()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(BOMRendererFactory thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

newBOMOrgFilter

public static BOMOrgFilter newBOMOrgFilter()
                                    throws ESIRendererException
Returns an instance of BOMOrgFilter (or an appropriate subclass). Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
BOMOrgFilter
Throws:
ESIRendererException

newBOMRenderer

public static BOMRenderer newBOMRenderer()
Returns an instance of the appropriate implementation of BOMRenderer. Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
BOMRenderer

newBOMHeaderRenderer

public static BOMHeaderRenderer newBOMHeaderRenderer()
                                              throws ESIRendererException
Returns an instance of the appropriate implementation of BOMHeaderRenderer. Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
BOMHeaderRenderer
Throws:
ESIRendererException

newBOMComponentRenderer

public static BOMComponentRenderer newBOMComponentRenderer()
                                                    throws ESIRendererException
Returns an instance of the appropriate implementation of BOMComponentRenderer. Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
BOMComponentRenderer
Throws:
ESIRendererException

newSubstituteRenderer

public static SubstituteRenderer newSubstituteRenderer()
                                                throws ESIRendererException
Returns an instance of the appropriate implementation of SubstituteRenderer. Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
SubstituteRenderer
Throws:
ESIRendererException

newReferenceDesignatorRenderer

public static ReferenceDesignatorRenderer newReferenceDesignatorRenderer()
                                                                  throws ESIRendererException
Returns an instance of the appropriate implementation of ReferenceDesignatorRenderer. Obtains the name of the class from ESIProperties.

Supported API: true

Returns:
ReferenceDesignatorRenderer
Throws:
ESIRendererException

newObjectFromProperty

private static Object newObjectFromProperty(ESIPropertyRequest property)
                                     throws ESIRendererException
Throws:
ESIRendererException