com.webmethods.caf.common.model

Interface IDocumentStructureProvider

public interface IDocumentStructureProvider

Abstract document structure definition. This information can be used for variety of purposes, for example for generating a java type that corresponds to this document structure, or for caching java type bean info. This interface does not fully support self-referencing definitions, i.e. a field that references back to another field of the same document.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDocumentStructureProvider.DocumentType
static interface	IDocumentStructureProvider.IFieldInfo Single document field information

Field Summary

Fields

Modifier and Type	Field and Description
static IDocumentStructureProvider.DocumentType	DOCTYPE_IS Document type for Integration Server documents.
static IDocumentStructureProvider.DocumentType	DOCTYPE_JAVA Document type that identifies java bean structure.
static IDocumentStructureProvider.DocumentType	DOCTYPE_MODELER Document type for Modeler logical data.
static IDocumentStructureProvider.DocumentType	DOCTYPE_UNKNOWN Document type for document of unknown type system.
static IDocumentStructureProvider.DocumentType	DOCTYPE_XML Document type for XML.

Method Summary

Modifier and Type	Method and Description
IDocumentStructureProvider.IFieldInfo	getDocumentInfo() Return document structure using IDocumentStructureProvider.IFieldInfo for the document itself with the following assumptions: getName may return null getType may return null isReadOnly must return false isComplexType must return true isArray must return false getFields must return non-empty array
IDocumentStructureProvider.DocumentType	getDocumentType() Returns document type for this provider
String	getDocumentURL() Return URL accessible location of this document if available

Field Detail

DOCTYPE_UNKNOWN

static final IDocumentStructureProvider.DocumentType DOCTYPE_UNKNOWN

Document type for document of unknown type system.

DOCTYPE_JAVA

static final IDocumentStructureProvider.DocumentType DOCTYPE_JAVA

Document type that identifies java bean structure. Field types are actual java class names. No type mapping is required.

DOCTYPE_IS

static final IDocumentStructureProvider.DocumentType DOCTYPE_IS

Document type for Integration Server documents. Field types are defined in IS type system. Mapping is required.

DOCTYPE_MODELER

static final IDocumentStructureProvider.DocumentType DOCTYPE_MODELER

Document type for Modeler logical data. Field types are defined in Modeler logical data type system. Mapping is required.

DOCTYPE_XML

static final IDocumentStructureProvider.DocumentType DOCTYPE_XML

Document type for XML. Field types are defined in XSD types. Mapping is required.

Method Detail

getDocumentInfo

IDocumentStructureProvider.IFieldInfo getDocumentInfo()

Return document structure using IDocumentStructureProvider.IFieldInfo for the document itself with the following assumptions:

• getName may return null
• getType may return null
• isReadOnly must return false
• isComplexType must return true
• isArray must return false
• getFields must return non-empty array

Returns:

document structure definition

getDocumentType

IDocumentStructureProvider.DocumentType getDocumentType()

Returns document type for this provider

Returns:

getDocumentURL

String getDocumentURL()

Return URL accessible location of this document if available

Returns:

null if unknown