com.ptc.windchill.structconf
Class Propagate

java.lang.Object
  com.ptc.windchill.structconf.StructConfManagerCommand
      com.ptc.windchill.structconf.Propagate

public class Propagate

extends StructConfManagerCommand

Command that instructs the StructConfManager to propagate xconfs into properties files.

Field Summary

private boolean	forcePropagate_
private boolean	forceXconfScan_
private XconfAnalysis	resultXconfAnalysis_
private boolean	targetUnix_

Fields inherited from class com.ptc.windchill.structconf.StructConfManagerCommand

Constructor Summary

Propagate()
Creates and instance that relies upon timestamp and file-existence analysis to determine if to regenerate target files.

Propagate(boolean force_propagate, boolean force_xconf_scan)
Configurable constructor.

Method Summary

(package private) void	execute()
XconfAnalysis	getXconfAnalysis()
boolean	hasXconfAnalysis() Whether or not the propagate command has an XconfAnalysis available for the caller to use.
(package private) void	setForcePropagate(boolean force)
(package private) void	setForceXconfScan(boolean force)

Methods inherited from class com.ptc.windchill.structconf.StructConfManagerCommand

execute, getCollector, getDeclarativeUpdater, getManager, getSiteUpdater, getUpdater, getUpdater, requiresSaveImmediatelyAfter, setRequiresSaveImmediatelyAfter

Methods inherited from class java.lang.Object

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

Field Detail

targetUnix_

private boolean targetUnix_

forcePropagate_

private boolean forcePropagate_

forceXconfScan_

private boolean forceXconfScan_

resultXconfAnalysis_

private XconfAnalysis resultXconfAnalysis_

Constructor Detail

Propagate

public Propagate()

Creates and instance that relies upon timestamp and file-existence analysis to determine if to regenerate target files.

Propagate

public Propagate(boolean force_propagate,
                 boolean force_xconf_scan)

Configurable constructor.

Parameters:

force_propagate - Set whether or not to force propagatation when it is executed. If true, no timestamp or file-existence analysis will be performed. Rather, xconfs will be propagated even if it is unnecessary.

force_xconf_scan - Set whether or not to force a rescan of all xconf files when it is executed. If true, the property-to-xconf file dependencies in the cached will be ignored. This is slower than trusting the cache but can be used to defeat an incorrect cache or one that is dated in the future (e.g. when you updated to an old view label).

Method Detail

execute

void execute()
       throws InvalidXconfException,
              StructConfManagerException

Specified by:

execute in class StructConfManagerCommand

Throws:

InvalidXconfException

StructConfManagerException

setForcePropagate

void setForcePropagate(boolean force)

setForceXconfScan

void setForceXconfScan(boolean force)

hasXconfAnalysis

public boolean hasXconfAnalysis()

Whether or not the propagate command has an XconfAnalysis available for the caller to use. Will be null if:

• the command has not run
• the command is currently running
• the command has failed
• the command succeeded, but propagation did not occur because propagation was not forved and all xconf target files were considered up to date

getXconfAnalysis

public XconfAnalysis getXconfAnalysis()

Returns:

possibly null result (see hasXconfAnalysis() for a description of when it will and will not be available)