uk.apl.jxc.mapper
Class XMLDefault

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

public class XMLDefault
extends AbstractXMLMapping

AbstractXMLMapping sub-class that causes the XMLMapper to output the defaultValue argument into the leaf element or attribute specified by the targetPath parameter.

Author:

Andrew Leigh

Constructor Summary

XMLDefault(java.lang.String targetPath, java.lang.String condition, java.lang.String defaultValue)
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

XMLDefault

public XMLDefault(java.lang.String targetPath,
                  java.lang.String condition,
                  java.lang.String defaultValue)

Constructs a new AbstractXMLMapping

Parameters:

targetPath - path to and including the element or attribute in the target schema

condition - a boolean XPath condition for the mapping, the mapping will only be performed if the condition evaluates to true

defaultValue - a literal value to be output into the target document

Throws:

InvalidMappingException - if an attempt is made to construct an XMLDefault with a null or empty targetPath or a null defaultValue

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:

always true indicating this mapping is for a default value