|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.query.mapping.xml.MappingNodeConstants.Properties
public static final class MappingNodeConstants.Properties
Property names for type-specific node properties. Values will be of type String unless otherwise specified.
Field Summary | |
---|---|
static java.lang.Integer |
ALIAS_RESULT_SET_NAME
In the case of the recursive mapping element nodes, the source nodes may be different, in that case the original result set name (i.e. |
static java.lang.Integer |
ALWAYS_INCLUDE
A property to mark to implicity include a node which needs to be added to result document. |
static java.lang.Integer |
BUILT_IN_TYPE
Specifies the design-time base built-in type for the virtual document node. |
static java.lang.Integer |
CARDINALITY_MAX_BOUND
The maximum number of times this node may occur in a document. |
static java.lang.Integer |
CARDINALITY_MIN_BOUND
The minimum number of times this node must occur in a document. |
static java.lang.Integer |
COMMENT_TEXT
The text for a comment. |
static java.lang.Integer |
CRITERIA
An optional constraint that applies for the node. |
static java.lang.Integer |
DEFAULT_VALUE
This property represents a default value for an XML node |
static java.lang.Integer |
DOCUMENT_ENCODING
The encoding format of the document. |
static java.lang.Integer |
ELEMENT_NAME
The symbol from a result set that maps to this node. |
static java.lang.Integer |
EXCEPTION_ON_DEFAULT
This property of a choice node indicates that, by default (if none of the choices evaluate to true), an exception will be thrown. |
static java.lang.Integer |
EXCEPTION_ON_RECURSION_LIMIT
If recursion is terminated due to the safeguard RECURSION_LIMIT being
reached, this property controls whether an exception will be thrown or not. |
static java.lang.Integer |
FIXED_VALUE
This property represents a fixed value for an XML node |
static java.lang.Integer |
FORMATTED_DOCUMENT
Indicates whether the document will be outputted as a compressed String, or in readable form, with line breaks or indenting. |
static java.lang.Integer |
IS_DEFAULT_CHOICE
This property of a single child of a choice node marks that child as representing the default choice of the choice node. |
static java.lang.Integer |
IS_EXCLUDED
This node will be completely ignored, not output, not processed |
static java.lang.Integer |
IS_INCLUDED
The temporary property to mark whether this node should be included. |
static java.lang.Integer |
IS_NILLABLE
Value will be of type Boolean. |
static java.lang.Integer |
IS_OPTIONAL
Indicates that the element or attribute is to be considered optional, even if it has a fixed or default value - it should be removed from the result doc if it doesn't have child content or doesn't receive character content from the underlying data store. |
static java.lang.Integer |
IS_RECURSIVE
Indicates if the node is the root of a recursive XML fragment or not. |
static java.lang.Integer |
IS_RECURSIVE_ROOT
Indicates if the node is the root of a recursive XML fragment or not. |
static java.lang.Integer |
NAME
The basic name of this node. |
static java.lang.Integer |
NAMESPACE_DECLARATIONS
This property allows for one or more namespace declarations (a namespace prefix and a namespace uri) at a given node. |
static java.lang.Integer |
NAMESPACE_PREFIX
The namespace prefix, which indicates the namespace for this node. |
static java.lang.Integer |
NODE_TYPE
The target node type. |
static java.lang.Integer |
NORMALIZE_TEXT
Indicates the level of text normalization that will be applied to the text content for a given element or attribute. |
static java.lang.Integer |
RECURSION_CRITERIA
The criteria of a node representing the root of a recursive XML fragment. |
static java.lang.Integer |
RECURSION_LIMIT
The recursion limit of a recursive XML fragment - if the RECURSION_CRITERIA does not terminate the recursion before
the limit is reached, the recursion will be terminated after this
many iterations. |
static java.lang.Integer |
RECURSION_ROOT_MAPPING_CLASS
This property should be set on each document node at which a recursive mapping class is anchored. |
static java.lang.Integer |
RESULT_SET_INFO
Result Set Info object which contains the query and the plan for the source node. |
static java.lang.Integer |
RESULT_SET_NAME
The name of the result being returned by this node |
static java.lang.Integer |
TEMP_GROUP_NAMES
The name(s) of the temporary group(s) to be materialized at this document node. |
Method Summary |
---|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Integer NAME
public static final java.lang.Integer NAMESPACE_PREFIX
NAMESPACE_DECLARATIONS
property.
public static final java.lang.Integer NAMESPACE_DECLARATIONS
This property allows for one or more namespace declarations
(a namespace prefix and a namespace uri) at a given node. The
object value should be a java.util.Properties object, where each
key is a String prefix and each value is the namespace String
uri. The prefix may then be referenced by other nodes via
the NAMESPACE_PREFIX
property.
One common example would be the XML Schema namespace for instances. In this case, the common convention is to use "xsi" for the prefix, and the uri is "http://www.w3.org/2001/XMLSchema-instance". This is commonly declared at the root node of the document instance. Then, elsewhere, a node may for example use the "nil" attribute from that namespace:
<shipDate xsi:nil="true"/>
public static final java.lang.Integer NODE_TYPE
MappingNodeConstants.ATTRIBUTE
or MappingNodeConstants.ELEMENT
.
public static final java.lang.Integer CARDINALITY_MIN_BOUND
The minimum number of times this node must occur in a document.
Type: java.lang.Integer
public static final java.lang.Integer CARDINALITY_MAX_BOUND
The maximum number of times this node may occur in a document.
Type: java.lang.Integer
public static final java.lang.Integer CRITERIA
public static final java.lang.Integer DEFAULT_VALUE
public static final java.lang.Integer FIXED_VALUE
public static final java.lang.Integer IS_NILLABLE
Value will be of type Boolean. Indicates that the node is nillable,
i.e. may have a child attribute xsi:nil="true"
,
where xsi indicates the W3C namespace for instances. This explicitly
indicates when the element has null content.
Note: This property may only be set to true if this node
is an element (i.e. the NODE_TYPE
property must have
a value of MappingNodeConstants.ELEMENT
), although this constraint is not
enforced anywhere in the MappingNode framework.
public static final java.lang.Integer IS_EXCLUDED
This node will be completely ignored, not output, not processed
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_IS_EXCLUDED
public static final java.lang.Integer RESULT_SET_NAME
public static final java.lang.Integer TEMP_GROUP_NAMES
Type: java.util.List
of java.lang.String
Default: MappingNodeConstants.Defaults.DEFAULT_TEMP_GROUP_NAMES
public static final java.lang.Integer ELEMENT_NAME
public static final java.lang.Integer IS_INCLUDED
public static final java.lang.Integer COMMENT_TEXT
public static final java.lang.Integer IS_OPTIONAL
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_IS_OPTIONAL
public static final java.lang.Integer NORMALIZE_TEXT
Indicates the level of text normalization that will be applied to the text content for a given element or attribute.
Type: java.lang.String
Default: MappingNodeConstants.Defaults.DEFAULT_NORMALIZE_TEXT
public static final java.lang.Integer BUILT_IN_TYPE
public static final java.lang.Integer IS_DEFAULT_CHOICE
This property of a single child of a choice node marks that child as representing the default choice of the choice node.
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_IS_DEFAULT_CHOICE
public static final java.lang.Integer EXCEPTION_ON_DEFAULT
This property of a choice node indicates that, by
default (if none of the choices evaluate to true), an
exception will be thrown. The order in which this
will be considered: first, check that a child node
is marked as the default choice
;
if not, then check this property. If it is true, throw
an exception, if false, do nothing.
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_EXCEPTION_ON_DEFAULT
public static final java.lang.Integer IS_RECURSIVE
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_IS_RECURSIVE
public static final java.lang.Integer RECURSION_CRITERIA
RECURSION_LIMIT
public static final java.lang.Integer RECURSION_LIMIT
RECURSION_CRITERIA
does not terminate the recursion before
the limit is reached, the recursion will be terminated after this
many iterations. This is to prevent runaway recursion.
Type: java.lang.Integer
Default: MappingNodeConstants.Defaults.DEFAULT_RECURSION_LIMIT
EXCEPTION_ON_RECURSION_LIMIT
public static final java.lang.Integer EXCEPTION_ON_RECURSION_LIMIT
RECURSION_LIMIT
being
reached, this property controls whether an exception will be thrown or not.
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_EXCEPTION_ON_RECURSION_LIMIT
RECURSION_CRITERIA
,
RECURSION_LIMIT
public static final java.lang.Integer RECURSION_ROOT_MAPPING_CLASS
Type: java.lang.String
public static final java.lang.Integer IS_RECURSIVE_ROOT
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_IS_RECURSIVE_ROOT
public static final java.lang.Integer DOCUMENT_ENCODING
The encoding format of the document. This property only needs to be set at the root MappingNode of the document.
Default: MappingNodeConstants.Defaults.DEFAULT_DOCUMENT_ENCODING
public static final java.lang.Integer FORMATTED_DOCUMENT
Indicates whether the document will be outputted as a compressed String, or in readable form, with line breaks or indenting. This property only needs to be set at the root MappingNode of the document.
Type: java.lang.Boolean
Default: MappingNodeConstants.Defaults.DEFAULT_FORMATTED_DOCUMENT
public static final java.lang.Integer ALWAYS_INCLUDE
public static final java.lang.Integer ALIAS_RESULT_SET_NAME
public static final java.lang.Integer RESULT_SET_INFO
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |