com.virtualweaver.xotics.datamodel
Interface XoConstants


public interface XoConstants

Some useful constants in Xotics environment

Version:
4.1

Field Summary
static byte ALL_CM
          Constant used (in a Content-Model description of a DMDL document) to identify a "All" node.
static byte ANY_CM
          Constant used (in a Content-Model description of a DMDL document) to identify a "Any" node.
static java.lang.String BUILD
          The version build number of Xotics API.
static byte CHILDREN_CM
          Constant used (in a Content-Model description of a DMDL document) to specify a content-model composed with element children only (no PCDATA).
static byte CHOICE_CM
          Constant used (in a Content-Model description of a DMDL document) to identify a "Choice" node.
static boolean DEFAULT_INIT_DMD_AUTO_LOADING_ENABLED_VALUE
          Default init value for DM instance DMD auto loading authorization.
static int DEFAULT_INIT_HISTORY_SIZE_VALUE
          Default init value for DM instance history size.
static boolean DEFAULT_INIT_READ_ONLY_VALUE
          Default init value for DM instance access status.
static boolean DEFAULT_INIT_REQUESTABLE_VALUE
          Default init value for DM instance XPath requestability.
static java.lang.String DMD_PI_TARGET
          Processing Instruction name (dmd in current version) to identify a Data-Model implementation needed to load before parsing current XML document.
static byte ELEMENT_REF_CM
          Constant used (in a Content-Model description of a DMDL document) to reference an element.
static byte EMPTY_CM
          Constant used (in a Content-Model description of a DMDL document) to identify a "Empty" node.
static java.lang.String INIT_DMD_AUTO_LOADING_ENABLED
          Init option used when loading/creating a DM instance, and in init options of DMDL.
static java.lang.String INIT_HISTORY_SIZE
          Init option used when loading/creating a DM instance, and in init options of DMDL.
static java.lang.String INIT_READ_ONLY
          Init option used when loading/creating a DM instance, and in init options of DMDL.
static java.lang.String INIT_REQUESTABLE
          Init option used when loading/creating a DM instance, and in init options of DMDL.
static java.lang.String MF_DMDL_KEY
          Manifest key name (currently Definition-path) to identify the class path of the Data-Model Definition File (DMDL) in a DM jar file.
static java.lang.String MF_NS_KEY
          Manifest key name (currently Namespace) to specify the namespace of a Data-Model jar file.
static byte MIXED_CM
          Element + PCDATA children content-model constant. if no element reference is specified, consider children as text nodes only
static byte SEQUENCE_CM
          Constant used (in a Content-Model description of a DMDL document) to identify a "Sequence" node.
static java.lang.String TEXT_CONTENT_PROPERTY_NAME
          The property name (xoTextContent in current version) of a text content in an XoTextContainer or XoText object.
static java.lang.String TEXT_NODE_ELEMENT_NAME
          The XML local name (#text in current version) of an XoText node.
static int UNBOUNDED_CM
          Unbounded occurrence constant in a content-model description.
static byte UNDOABLE_ADD_OBJECT
          Constant used to indicate an undoable "add object" action
static byte UNDOABLE_REMOVE_OBJECT
          Constant used to indicate an undoable "remove object" action
static byte UNDOABLE_SET_PROPERTY
          Constant used to indicate an undoable "set property" action
static java.lang.String VENDOR
          The vendor name of Xotics API.
static java.lang.String VERSION
          The version number of Xotics API.
static byte WS_COLLAPSE
          Collapse white spaces directive, used for XoObject.setXmlWhiteSpace(byte) and XSD datatype restrictions.
static byte WS_PRESERVE
          Preserve white spaces directive, used for XoObject.setXmlWhiteSpace(byte) and XSD datatype restrictions.
static byte WS_REPLACE
          Replace white spaces directive (used for XML Schema datatype restrictions).
 

Field Detail

VENDOR

public static final java.lang.String VENDOR
The vendor name of Xotics API.

See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
The version number of Xotics API.

See Also:
Constant Field Values

BUILD

public static final java.lang.String BUILD
The version build number of Xotics API.

See Also:
Constant Field Values

TEXT_NODE_ELEMENT_NAME

public static final java.lang.String TEXT_NODE_ELEMENT_NAME
The XML local name (#text in current version) of an XoText node.

See Also:
Constant Field Values

TEXT_CONTENT_PROPERTY_NAME

public static final java.lang.String TEXT_CONTENT_PROPERTY_NAME
The property name (xoTextContent in current version) of a text content in an XoTextContainer or XoText object.

See Also:
Constant Field Values

WS_REPLACE

public static final byte WS_REPLACE
Replace white spaces directive (used for XML Schema datatype restrictions).

See Also:
com.virtualweaver.xotics.datamodel.datatype, Constant Field Values

WS_COLLAPSE

public static final byte WS_COLLAPSE
Collapse white spaces directive, used for XoObject.setXmlWhiteSpace(byte) and XSD datatype restrictions. Corresponds in XML document to xml:space = DEFAULT

See Also:
Constant Field Values

WS_PRESERVE

public static final byte WS_PRESERVE
Preserve white spaces directive, used for XoObject.setXmlWhiteSpace(byte) and XSD datatype restrictions. Corresponds in XML document to xml:space = PRESERVE

See Also:
Constant Field Values

DMD_PI_TARGET

public static final java.lang.String DMD_PI_TARGET
Processing Instruction name (dmd in current version) to identify a Data-Model implementation needed to load before parsing current XML document.

See Also:
Constant Field Values

MF_NS_KEY

public static final java.lang.String MF_NS_KEY
Manifest key name (currently Namespace) to specify the namespace of a Data-Model jar file.

See Also:
Constant Field Values

MF_DMDL_KEY

public static final java.lang.String MF_DMDL_KEY
Manifest key name (currently Definition-path) to identify the class path of the Data-Model Definition File (DMDL) in a DM jar file.

See Also:
Constant Field Values

CHOICE_CM

public static final byte CHOICE_CM
Constant used (in a Content-Model description of a DMDL document) to identify a "Choice" node.

See Also:
Constant Field Values

SEQUENCE_CM

public static final byte SEQUENCE_CM
Constant used (in a Content-Model description of a DMDL document) to identify a "Sequence" node.

See Also:
Constant Field Values

ALL_CM

public static final byte ALL_CM
Constant used (in a Content-Model description of a DMDL document) to identify a "All" node. "All" operator is defined in XML Schema standard.

See Also:
Constant Field Values

ELEMENT_REF_CM

public static final byte ELEMENT_REF_CM
Constant used (in a Content-Model description of a DMDL document) to reference an element.

See Also:
Constant Field Values

CHILDREN_CM

public static final byte CHILDREN_CM
Constant used (in a Content-Model description of a DMDL document) to specify a content-model composed with element children only (no PCDATA).

See Also:
Constant Field Values

MIXED_CM

public static final byte MIXED_CM
Element + PCDATA children content-model constant. if no element reference is specified, consider children as text nodes only

See Also:
Constant Field Values

ANY_CM

public static final byte ANY_CM
Constant used (in a Content-Model description of a DMDL document) to identify a "Any" node.

See Also:
Constant Field Values

EMPTY_CM

public static final byte EMPTY_CM
Constant used (in a Content-Model description of a DMDL document) to identify a "Empty" node.

See Also:
Constant Field Values

UNBOUNDED_CM

public static final int UNBOUNDED_CM
Unbounded occurrence constant in a content-model description.

See Also:
Constant Field Values

INIT_READ_ONLY

public static final java.lang.String INIT_READ_ONLY
Init option used when loading/creating a DM instance, and in init options of DMDL. Sets DM instance in read-only or read-write mode. Valid corresponding values are String "true" or "false" or Boolean.

See Also:
Constant Field Values

INIT_REQUESTABLE

public static final java.lang.String INIT_REQUESTABLE
Init option used when loading/creating a DM instance, and in init options of DMDL. Sets DM instance XPath requestable or not at creation time. Valid corresponding values are String "true" or "false" or Boolean. Note that this option can not be changed for created/loaded DM instances because it affects the creation process.

See Also:
Constant Field Values

INIT_HISTORY_SIZE

public static final java.lang.String INIT_HISTORY_SIZE
Init option used when loading/creating a DM instance, and in init options of DMDL. Sets DM instance history size. Valid corresponding value is a String representing an integer or an Integer object.

See Also:
Constant Field Values

INIT_DMD_AUTO_LOADING_ENABLED

public static final java.lang.String INIT_DMD_AUTO_LOADING_ENABLED
Init option used when loading/creating a DM instance, and in init options of DMDL. Informs XoFactory that, in a DM instance loading from XML file, it can use PI specifying DMDL location URL to load DM modules if necessary. This option also sets DM instance property insertDMLocation at the same value. Valid corresponding values are String "true" or "false" or Boolean.

See Also:
Constant Field Values

DEFAULT_INIT_HISTORY_SIZE_VALUE

public static final int DEFAULT_INIT_HISTORY_SIZE_VALUE
Default init value for DM instance history size.

See Also:
Constant Field Values

DEFAULT_INIT_REQUESTABLE_VALUE

public static final boolean DEFAULT_INIT_REQUESTABLE_VALUE
Default init value for DM instance XPath requestability.

See Also:
Constant Field Values

DEFAULT_INIT_READ_ONLY_VALUE

public static final boolean DEFAULT_INIT_READ_ONLY_VALUE
Default init value for DM instance access status.

See Also:
Constant Field Values

DEFAULT_INIT_DMD_AUTO_LOADING_ENABLED_VALUE

public static final boolean DEFAULT_INIT_DMD_AUTO_LOADING_ENABLED_VALUE
Default init value for DM instance DMD auto loading authorization.

See Also:
Constant Field Values

UNDOABLE_SET_PROPERTY

public static final byte UNDOABLE_SET_PROPERTY
Constant used to indicate an undoable "set property" action

See Also:
XoUndoableEvent, Constant Field Values

UNDOABLE_ADD_OBJECT

public static final byte UNDOABLE_ADD_OBJECT
Constant used to indicate an undoable "add object" action

See Also:
XoUndoableEvent, Constant Field Values

UNDOABLE_REMOVE_OBJECT

public static final byte UNDOABLE_REMOVE_OBJECT
Constant used to indicate an undoable "remove object" action

See Also:
XoUndoableEvent, Constant Field Values