uk.apl.jxc.mapper
Class XMLControl

java.lang.Object
  uk.apl.jxc.mapper.AbstractXMLMapping
      uk.apl.jxc.mapper.XMLControl

public class XMLControl
extends AbstractXMLMapping

AbstractXMLMapping sub-class that causes XMLMapper to iterate over the source document using the XPath selection specified by the sourcePath argument. This kind of mapping does not result in any elements or attributes being output into the target document. Therefore, this kind of mapping is purely for controlling how the XMLMapper iterates over the source document.

Author:

Andrew Leigh

Constructor Summary

XMLControl(java.lang.String sourcePath)
Constructs a new AbstractXMLMapping.

XMLControl(java.lang.String sourcePath, java.lang.String condition)
Constructs a new AbstractXMLMapping.

Method Summary

boolean

isDefault() When true the value of sourcePath will be defaulted as a literal value into the target instead of being used to select from the source schema.

Methods inherited from class uk.apl.jxc.mapper.AbstractXMLMapping

conditionsEqual, create, getCondition, getDefaultValue, getFunction, getSelectString, getSourcePath, getTargetElementName, getTargetPath, isAttribute, isConditional, isEmpty, isRootElement, isTargetAttributeOrLeaf, targetsEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLControl

public XMLControl(java.lang.String sourcePath)

Constructs a new AbstractXMLMapping.

Parameters:

sourcePath - path to and including the element or attribute in the source schema

Throws:

InvalidMappingException - if an attempt is made to construct an XMLControl with a null or empty sourcePath

See Also:

AbstractXMLMapping.create(java.lang.String, java.lang.String, java.lang.String, uk.apl.jxc.XSLTFunction, java.lang.String)

XMLControl

public XMLControl(java.lang.String sourcePath,
                  java.lang.String condition)

Constructs a new AbstractXMLMapping.

Parameters:

sourcePath - path to and including the element or attribute in the source schema

Throws:

InvalidMappingException - if an attempt is made to construct an XMLControl with a null or empty sourcePath

See Also:

AbstractXMLMapping.create(java.lang.String, java.lang.String, java.lang.String, uk.apl.jxc.XSLTFunction, java.lang.String)

Method Detail

isDefault

public boolean isDefault()

When true the value of sourcePath will be defaulted as a literal value into the target instead of being used to select from the source schema.

Specified by:

isDefault in class AbstractXMLMapping

Returns:

false always becuse this class is not a default

See Also:

XMLDefault