oracle.jbo.service.helper

Class SDOXsdDocumentHelper

java.lang.Object

oracle.jbo.service.helper.SDOXsdDocumentHelper

public class SDOXsdDocumentHelper
extends java.lang.Object

Since:

11.1.1.6.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OER_NS_PREFIX
static java.lang.String	OER_NS_URI

Constructor Summary

Constructors

Constructor and Description
SDOXsdDocumentHelper()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getCategoryValues(org.w3c.dom.Element docEl, ViewAnnotations.Category category)
static java.lang.String	getLifecycle(org.w3c.dom.Element docEl)
static java.util.List<java.lang.String[]>	getRelationships(org.w3c.dom.Element docEl)
static void	updateXsdDocumentation(org.w3c.dom.Document xsdDoc, SDOAnnotationProvider provider) Updates the <xsd:documentation> element with the specified service data object annotations.
static void	writeCategoryValuesInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, ViewAnnotations.Category category, java.util.List<java.lang.String> catList)
static void	writeDescriptionInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.lang.String description)
static void	writeDocumentationInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.util.List<java.lang.String[]> documentList)
static void	writeKeywordsInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.util.List<java.lang.String> keywords)
static void	writeLifecycleInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.lang.String lifecycle)
static void	writeNameInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.lang.String name)
static void	writeRelationshipsInternal(org.w3c.dom.Document document, org.w3c.dom.Element docEl, java.util.List<java.lang.String[]> relationList)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OER_NS_URI

public static final java.lang.String OER_NS_URI

See Also:

Constant Field Values

OER_NS_PREFIX

public static final java.lang.String OER_NS_PREFIX

See Also:

Constant Field Values

Constructor Detail

SDOXsdDocumentHelper

public SDOXsdDocumentHelper()

Method Detail

updateXsdDocumentation

public static void updateXsdDocumentation(org.w3c.dom.Document xsdDoc,
                                          SDOAnnotationProvider provider)
                                   throws java.lang.Exception

Updates the <xsd:documentation> element with the specified service data object annotations. If the specified XML Schema does not have an annotation element, one will be created and set on the schema.

Parameters:

xsdDoc - the enclosing XSD document

provider - the annotation provider for the service data object

Throws:

java.lang.Exception - an error occurs parsing the schema

writeNameInternal

@Concealed
public static void writeNameInternal(org.w3c.dom.Document document,
                                                org.w3c.dom.Element docEl,
                                                java.lang.String name)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

name - name of the SDO

For internal use only. Application developers should not use this

Internal use only.

writeDescriptionInternal

@Concealed
public static void writeDescriptionInternal(org.w3c.dom.Document document,
                                                       org.w3c.dom.Element docEl,
                                                       java.lang.String description)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

description - description of the SDO

For internal use only. Application developers should not use this

Internal use only.

writeLifecycleInternal

@Concealed
public static void writeLifecycleInternal(org.w3c.dom.Document document,
                                                     org.w3c.dom.Element docEl,
                                                     java.lang.String lifecycle)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

lifecycle - lifecycle of the SDO

For internal use only. Application developers should not use this

Internal use only.

getLifecycle

public static java.lang.String getLifecycle(org.w3c.dom.Element docEl)

writeKeywordsInternal

@Concealed
public static void writeKeywordsInternal(org.w3c.dom.Document document,
                                                    org.w3c.dom.Element docEl,
                                                    java.util.List<java.lang.String> keywords)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

keywords - list of keywords for the SDO

For internal use only. Application developers should not use this

Internal use only.

writeCategoryValuesInternal

@Concealed
public static void writeCategoryValuesInternal(org.w3c.dom.Document document,
                                                          org.w3c.dom.Element docEl,
                                                          ViewAnnotations.Category category,
                                                          java.util.List<java.lang.String> catList)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

category - category for the SDO

catList - list of category values assigned to the SDO

For internal use only. Application developers should not use this

Internal use only.

getCategoryValues

public static java.util.List<java.lang.String> getCategoryValues(org.w3c.dom.Element docEl,
                                                                 ViewAnnotations.Category category)

writeDocumentationInternal

@Concealed
public static void writeDocumentationInternal(org.w3c.dom.Document document,
                                                         org.w3c.dom.Element docEl,
                                                         java.util.List<java.lang.String[]> documentList)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

documentList - list of document names and URLs

For internal use only. Application developers should not use this

Internal use only.

writeRelationshipsInternal

@Concealed
public static void writeRelationshipsInternal(org.w3c.dom.Document document,
                                                         org.w3c.dom.Element docEl,
                                                         java.util.List<java.lang.String[]> relationList)

Parameters:

document - the enclosing XSD document

docEl - the <xsd:documentation> element in this document

relationList - list of related object names and their relationship types

For internal use only. Application developers should not use this

Internal use only.

getRelationships

public static java.util.List<java.lang.String[]> getRelationships(org.w3c.dom.Element docEl)