com.ptc.windchill.structconf.xconf
Class DefaultXconfHandler

java.lang.Object
  com.ptc.windchill.structconf.xconf.DefaultXconfHandler

All Implemented Interfaces:

XconfHandler

Direct Known Subclasses:

TargetFileContentsCollector.CollectingXconfHandler

public class DefaultXconfHandler

extends Object

implements XconfHandler

An "adapter" to XconfHandler for classes that do not want or need to implement all parse "event" callback methods.

See Also:

XconfHandler

Constructor Summary

DefaultXconfHandler()

Method Summary

void	addToProperty(XconfParser parser, String property_name, String value)
void	endConfiguration(XconfParser parser, URL xconf_file)
void	endResource(XconfParser parser, String resource_name, String resource_context)
void	endService(XconfParser parser, String service_name, String service_context)
void	propagationActionDeclared(XconfParser parser, String class_name, String[] class_path_entries)
void	propertyDeclared(XconfParser parser, String property_name, String default_value, boolean overridable, String multivalued_delimiter, PropertyDocumentation documentation)
void	propertyReset(XconfParser parser, String property_name)
void	propertySiteValue(XconfParser parser, String property_name, String value)
void	propertyUndefined(XconfParser parser, String property_name)
void	referencedConfigurationNotFound(XconfParser parser, URL href) Default implementation is to throw a SAXException.
void	removeFromProperty(XconfParser parser, String property_name, String value)
void	resourceOption(XconfParser parser, String selector, String requestor, int order, String resource, boolean overridable)
void	serviceOption(XconfParser parser, String selector, String requestor, int order, String service_class, String cardinality, boolean overridable)
void	startConfiguration(XconfParser parser, URL xconf_file)
void	startResource(XconfParser parser, String resource_name, String resource_context)
void	startService(XconfParser parser, String service_name, String service_context)
protected void	throwException(String message, Exception ex)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXconfHandler

public DefaultXconfHandler()

Method Detail

referencedConfigurationNotFound

public void referencedConfigurationNotFound(XconfParser parser,
                                            URL href)
                                     throws SAXException

Default implementation is to throw a SAXException. Subtypes can override and not call super in order to ignore error.

Specified by:

referencedConfigurationNotFound in interface XconfHandler

Throws:

SAXException

startConfiguration

public void startConfiguration(XconfParser parser,
                               URL xconf_file)
                        throws SAXException

Specified by:

startConfiguration in interface XconfHandler

Throws:

SAXException

endConfiguration

public void endConfiguration(XconfParser parser,
                             URL xconf_file)
                      throws SAXException

Specified by:

endConfiguration in interface XconfHandler

Throws:

SAXException

propertyDeclared

public void propertyDeclared(XconfParser parser,
                             String property_name,
                             String default_value,
                             boolean overridable,
                             String multivalued_delimiter,
                             PropertyDocumentation documentation)
                      throws SAXException

Specified by:

propertyDeclared in interface XconfHandler

Parameters:

parser -

property_name -

default_value -

overridable -

multivalued_delimiter - null if property is not multivalued, not-null if it is...string will be the delimiter for separating values

documentation -

Throws:

SAXException

propertySiteValue

public void propertySiteValue(XconfParser parser,
                              String property_name,
                              String value)
                       throws SAXException

Specified by:

propertySiteValue in interface XconfHandler

Throws:

SAXException

addToProperty

public void addToProperty(XconfParser parser,
                          String property_name,
                          String value)
                   throws SAXException

Specified by:

addToProperty in interface XconfHandler

Throws:

SAXException

removeFromProperty

public void removeFromProperty(XconfParser parser,
                               String property_name,
                               String value)
                        throws SAXException

Specified by:

removeFromProperty in interface XconfHandler

Throws:

SAXException

propertyUndefined

public void propertyUndefined(XconfParser parser,
                              String property_name)
                       throws SAXException

Specified by:

propertyUndefined in interface XconfHandler

Throws:

SAXException

propertyReset

public void propertyReset(XconfParser parser,
                          String property_name)
                   throws SAXException

Specified by:

propertyReset in interface XconfHandler

Throws:

SAXException

startService

public void startService(XconfParser parser,
                         String service_name,
                         String service_context)
                  throws SAXException

Specified by:

startService in interface XconfHandler

Throws:

SAXException

endService

public void endService(XconfParser parser,
                       String service_name,
                       String service_context)
                throws SAXException

Specified by:

endService in interface XconfHandler

Throws:

SAXException

startResource

public void startResource(XconfParser parser,
                          String resource_name,
                          String resource_context)
                   throws SAXException

Specified by:

startResource in interface XconfHandler

Throws:

SAXException

endResource

public void endResource(XconfParser parser,
                        String resource_name,
                        String resource_context)
                 throws SAXException

Specified by:

endResource in interface XconfHandler

Throws:

SAXException

serviceOption

public void serviceOption(XconfParser parser,
                          String selector,
                          String requestor,
                          int order,
                          String service_class,
                          String cardinality,
                          boolean overridable)
                   throws SAXException

Specified by:

serviceOption in interface XconfHandler

Throws:

SAXException

resourceOption

public void resourceOption(XconfParser parser,
                           String selector,
                           String requestor,
                           int order,
                           String resource,
                           boolean overridable)
                    throws SAXException

Specified by:

resourceOption in interface XconfHandler

Throws:

SAXException

propagationActionDeclared

public void propagationActionDeclared(XconfParser parser,
                                      String class_name,
                                      String[] class_path_entries)
                               throws SAXException

Specified by:

propagationActionDeclared in interface XconfHandler

Throws:

SAXException

throwException

protected final void throwException(String message,
                                    Exception ex)