org.teiid.query.mapping.xml
Enum MappingNodeConstants.Properties

java.lang.Object
  java.lang.Enum<MappingNodeConstants.Properties>
      org.teiid.query.mapping.xml.MappingNodeConstants.Properties

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MappingNodeConstants.Properties>

Enclosing class:

MappingNodeConstants

public static enum MappingNodeConstants.Properties
extends java.lang.Enum<MappingNodeConstants.Properties>

Property names for type-specific node properties. Values will be of type String unless otherwise specified.

Enum Constant Summary

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.

ALWAYS_INCLUDE
A property to mark to implicity include a node which needs to be added to result document.

BUILT_IN_TYPE
Specifies the design-time base built-in type for the virtual document node.

CARDINALITY_MAX_BOUND
The maximum number of times this node may occur in a document.

CARDINALITY_MIN_BOUND
The minimum number of times this node must occur in a document.

COMMENT_TEXT
The text for a comment.

CRITERIA
An optional constraint that applies for the node.

DEFAULT_VALUE
This property represents a default value for an XML node

DOCUMENT_ENCODING
The encoding format of the document.

ELEMENT_NAME
The symbol from a result set that maps to this node.

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.

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.

FIXED_VALUE
This property represents a fixed value for an XML node

FORMATTED_DOCUMENT
Indicates whether the document will be outputted as a compressed String, or in readable form, with line breaks or indenting.

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.

IS_EXCLUDED
This node will be completely ignored, not output, not processed

IS_INCLUDED
The temporary property to mark whether this node should be included.

IS_NILLABLE
Value will be of type Boolean.

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.

IS_RECURSIVE
Indicates if the node is the root of a recursive XML fragment or not.

IS_RECURSIVE_ROOT
Indicates if the node is the root of a recursive XML fragment or not.

NAME
The basic name of this node.

NAMESPACE_DECLARATIONS
This property allows for one or more namespace declarations (a namespace prefix and a namespace uri) at a given node.

NAMESPACE_PREFIX
The namespace prefix, which indicates the namespace for this node.

NODE_TYPE
The target node type.

NORMALIZE_TEXT
Indicates the level of text normalization that will be applied to the text content for a given element or attribute.

RECURSION_CRITERIA
The criteria of a node representing the root of a recursive XML fragment.

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.

RECURSION_ROOT_MAPPING_CLASS
This property should be set on each document node at which a recursive mapping class is anchored.

RESULT_SET_INFO
Result Set Info object which contains the query and the plan for the source node.

RESULT_SET_NAME
The name of the result being returned by this node

TEMP_GROUP_NAMES
The name(s) of the temporary group(s) to be materialized at this document node.

Method Summary

static MappingNodeConstants.Properties	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MappingNodeConstants.Properties[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final MappingNodeConstants.Properties NAME

The basic name of this node. Will be the element or attribute tag name.

NAMESPACE_PREFIX

public static final MappingNodeConstants.Properties NAMESPACE_PREFIX

The namespace prefix, which indicates the namespace for this node. The namespace must be declared either at this node or an ancestor node; use the NAMESPACE_DECLARATIONS property.

NAMESPACE_DECLARATIONS

public static final MappingNodeConstants.Properties 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"/>

NODE_TYPE

public static final MappingNodeConstants.Properties NODE_TYPE

The target node type. Can take on one of the values MappingNodeConstants.ATTRIBUTE or MappingNodeConstants.ELEMENT.

CARDINALITY_MIN_BOUND

public static final MappingNodeConstants.Properties CARDINALITY_MIN_BOUND

The minimum number of times this node must occur in a document.

Type: java.lang.Integer

CARDINALITY_MAX_BOUND

public static final MappingNodeConstants.Properties CARDINALITY_MAX_BOUND

The maximum number of times this node may occur in a document.

Type: java.lang.Integer

CRITERIA

public static final MappingNodeConstants.Properties CRITERIA

An optional constraint that applies for the node. If a constraint is defined, the input tuple to the node will be compared to the constraint. The node will be processed only if the constraint is satisfied.

DEFAULT_VALUE

public static final MappingNodeConstants.Properties DEFAULT_VALUE

This property represents a default value for an XML node

FIXED_VALUE

public static final MappingNodeConstants.Properties FIXED_VALUE

This property represents a fixed value for an XML node

IS_NILLABLE

public static final MappingNodeConstants.Properties 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 #NODETYPE property must have a value of MappingNodeConstants.ELEMENT), although this constraint is not enforced anywhere in the MappingNode framework.

IS_EXCLUDED

public static final MappingNodeConstants.Properties IS_EXCLUDED

This node will be completely ignored, not output, not processed

Type: java.lang.Boolean

Default: MappingNodeConstants.Defaults.DEFAULT_IS_EXCLUDED

RESULT_SET_NAME

public static final MappingNodeConstants.Properties RESULT_SET_NAME

The name of the result being returned by this node

TEMP_GROUP_NAMES

public static final MappingNodeConstants.Properties TEMP_GROUP_NAMES

The name(s) of the temporary group(s) to be materialized at this document node.

Type: java.util.List of java.lang.String

Default: MappingNodeConstants.Defaults.DEFAULT_TEMP_GROUP_NAMES

ELEMENT_NAME

public static final MappingNodeConstants.Properties ELEMENT_NAME

The symbol from a result set that maps to this node.

IS_INCLUDED

public static final MappingNodeConstants.Properties IS_INCLUDED

The temporary property to mark whether this node should be included.

COMMENT_TEXT

public static final MappingNodeConstants.Properties COMMENT_TEXT

The text for a comment.

IS_OPTIONAL

public static final MappingNodeConstants.Properties 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. See defect 12077

Type: java.lang.Boolean

Default: MappingNodeConstants.Defaults.DEFAULT_IS_OPTIONAL

NORMALIZE_TEXT

public static final MappingNodeConstants.Properties 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

BUILT_IN_TYPE

public static final MappingNodeConstants.Properties BUILT_IN_TYPE

Specifies the design-time base built-in type for the virtual document node. This property is optional and may not exist, particularly for legacy XML virtual docs or for nodes that are not mapped to data. This information is used to determine special translations from the runtime value to the expected XML schema output value string.

IS_DEFAULT_CHOICE

public static final MappingNodeConstants.Properties 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

EXCEPTION_ON_DEFAULT

public static final MappingNodeConstants.Properties 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

IS_RECURSIVE

public static final MappingNodeConstants.Properties IS_RECURSIVE

Indicates if the node is the root of a recursive XML fragment or not.

Type: java.lang.Boolean

Default: MappingNodeConstants.Defaults.DEFAULT_IS_RECURSIVE

RECURSION_CRITERIA

public static final MappingNodeConstants.Properties RECURSION_CRITERIA

The criteria of a node representing the root of a recursive XML fragment. The criteria should specify under what circumstances the recursion should terminate. i.e. "resultSetName.employeeName = 'Jones'"

See Also:

RECURSION_LIMIT

RECURSION_LIMIT

public static final MappingNodeConstants.Properties 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. This is to prevent runaway recursion.

Type: java.lang.Integer

Default: MappingNodeConstants.Defaults.DEFAULT_RECURSION_LIMIT

See Also:

EXCEPTION_ON_RECURSION_LIMIT

EXCEPTION_ON_RECURSION_LIMIT

public static final MappingNodeConstants.Properties 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.

Type: java.lang.Boolean

Default: MappingNodeConstants.Defaults.DEFAULT_EXCEPTION_ON_RECURSION_LIMIT

See Also:

RECURSION_CRITERIA, RECURSION_LIMIT

RECURSION_ROOT_MAPPING_CLASS

public static final MappingNodeConstants.Properties RECURSION_ROOT_MAPPING_CLASS

This property should be set on each document node at which a recursive mapping class is anchored. The value of this property should be the String name of the ancestor mapping class which is rooted at the recursive root node (i.e. the root of the recursive fragment of the document).

Type: java.lang.String

IS_RECURSIVE_ROOT

public static final MappingNodeConstants.Properties IS_RECURSIVE_ROOT

Indicates if the node is the root of a recursive XML fragment or not.

Type: java.lang.Boolean

Default: MappingNodeConstants.Defaults.DEFAULT_IS_RECURSIVE_ROOT

DOCUMENT_ENCODING

public static final MappingNodeConstants.Properties 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

FORMATTED_DOCUMENT

public static final MappingNodeConstants.Properties 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

ALWAYS_INCLUDE

public static final MappingNodeConstants.Properties ALWAYS_INCLUDE

A property to mark to implicity include a node which needs to be added to result document. The implicit nodes are such nodes which define the encoding information and type defination information.

ALIAS_RESULT_SET_NAME

public static final MappingNodeConstants.Properties 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. mapping class in recurive node) is alias to the source node which is above the recursive node.

RESULT_SET_INFO

public static final MappingNodeConstants.Properties RESULT_SET_INFO

Result Set Info object which contains the query and the plan for the source node.

Method Detail

values

public static MappingNodeConstants.Properties[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MappingNodeConstants.Properties c : MappingNodeConstants.Properties.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MappingNodeConstants.Properties valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null