oracle.apps.fnd.applcore.flex.runtime.util.service
Class FlexfieldXSDGenerator

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.util.service.FlexfieldXSDGenerator

public class FlexfieldXSDGenerator
extends java.lang.Object

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/applcore/applications/FlexModeler/Model/src/oracle/apps/fnd/applcore/flex/runtime/util/service/FlexfieldXSDGenerator.java /main/13 2010/12/17 13:29:59 jliu Exp $ A tool that generates XSD files for flexfield business components.

Author:

jliu

Nested Class Summary

static interface

FlexfieldXSDGenerator.XsdRepos The repository of XSD files.

Constructor Summary

FlexfieldXSDGenerator()
Constructs a FlexfieldXSDGenerator with FlexfieldSDOViewBuilderSrc as the FlexfieldSDOViewBuilderSrc class.

Method Summary

java.lang.String	generateXSD(oracle.jbo.server.ViewDefImpl viewDef, FlexfieldXSDGenerator.XsdRepos repos, java.util.Map<java.lang.String,java.lang.String> xsdNameToNamespaceMap) Generates the XSD file for a view definition and a list of view link definitions.
java.lang.String	getPreferredXSDName(java.lang.String viewDefShortName) Gets the preferred XSD short name (without extension) for a view definition.
java.lang.String	getPreferredXSDName(oracle.jbo.server.ViewDefImpl viewDef) Gets the preferred XSD short name (without extension) for a view definition.
java.lang.String	getPreferredXSDNameWithExt(java.lang.String viewDefShortName) Gets the preferred XSD name with extension for a view definition.
java.lang.String	getPreferredXSDNameWithExt(oracle.jbo.server.ViewDefImpl viewDef) Gets the preferred XSD name with extension for a view definition.
java.lang.String	getPreferredXsdPackage(java.lang.String viewDefFullName) Gets the preferred package of the XSD for a view definition.
java.lang.String	getPreferredXsdPackage(oracle.jbo.server.ViewDefImpl viewDef) Gets the preferred package of the XSD for a view definition.
FlexfieldSDOViewBuilderSrc	newFlexfieldSDOViewBuilderSrc(oracle.jbo.server.ViewDefImpl viewDef, commonj.sdo.helper.HelperContext hContext) Creates a new instance of FlexfieldSDOViewBuilderSrc for a view definition and a list of view link definitions.
FlexfieldSDOViewBuilderSrc	newFlexfieldSDOViewBuilderSrc(oracle.jbo.server.ViewLinkDefImpl viewLinkDef, java.lang.String rPath, commonj.sdo.helper.HelperContext hContext) Creates a new instance of FlexfieldSDOViewBuilderSrc for a view link definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexfieldXSDGenerator

public FlexfieldXSDGenerator()

Constructs a FlexfieldXSDGenerator with FlexfieldSDOViewBuilderSrc as the FlexfieldSDOViewBuilderSrc class.

Method Detail

newFlexfieldSDOViewBuilderSrc

public FlexfieldSDOViewBuilderSrc newFlexfieldSDOViewBuilderSrc(oracle.jbo.server.ViewDefImpl viewDef,
                                                                commonj.sdo.helper.HelperContext hContext)

Creates a new instance of FlexfieldSDOViewBuilderSrc for a view definition and a list of view link definitions. Subclasses may override this method to return their own implementation of FlexfieldSDOViewBuilderSrc.

Parameters:

viewDef - the view definition

hContext - the helper context

Returns:

the new instance of FlexfieldSDOViewBuilderSrc

newFlexfieldSDOViewBuilderSrc

public FlexfieldSDOViewBuilderSrc newFlexfieldSDOViewBuilderSrc(oracle.jbo.server.ViewLinkDefImpl viewLinkDef,
                                                                java.lang.String rPath,
                                                                commonj.sdo.helper.HelperContext hContext)

Creates a new instance of FlexfieldSDOViewBuilderSrc for a view link definition. Subclasses may override this method to return their own implementation of FlexfieldSDOViewBuilderSrc.

Parameters:

viewLinkDef - the view link definition

rPath - the relative path of the SDO, such as "a/b/c/v.xsd"

hContext - the helper context

Returns:

the new instance of FlexfieldSDOViewBuilderSrc

getPreferredXSDNameWithExt

public java.lang.String getPreferredXSDNameWithExt(java.lang.String viewDefShortName)

Gets the preferred XSD name with extension for a view definition.

Parameters:

viewDefShortName - the view definition

Returns:

the preferred XSD full name

getPreferredXSDNameWithExt

public java.lang.String getPreferredXSDNameWithExt(oracle.jbo.server.ViewDefImpl viewDef)

Gets the preferred XSD name with extension for a view definition.

Parameters:

viewDef - the view definition

Returns:

the preferred XSD full name

getPreferredXSDName

public java.lang.String getPreferredXSDName(oracle.jbo.server.ViewDefImpl viewDef)

Gets the preferred XSD short name (without extension) for a view definition.

Parameters:

viewDef - the view definition

Returns:

the preferred XSD name

getPreferredXSDName

public java.lang.String getPreferredXSDName(java.lang.String viewDefShortName)

Gets the preferred XSD short name (without extension) for a view definition.

Parameters:

viewDefShortName - the short name of the view definition

Returns:

the preferred XSD name

getPreferredXsdPackage

public java.lang.String getPreferredXsdPackage(oracle.jbo.server.ViewDefImpl viewDef)

Gets the preferred package of the XSD for a view definition.

Parameters:

viewDef - the view definition

Returns:

the package, such as "x.y.z"

Throws:

java.lang.IllegalArgumentException - if the given view definition is null

getPreferredXsdPackage

public java.lang.String getPreferredXsdPackage(java.lang.String viewDefFullName)

Gets the preferred package of the XSD for a view definition.

Parameters:

viewDefFullName - the full name of the view definition

Returns:

the package, such as "x.y.z"

Throws:

java.lang.IllegalArgumentException - if the given view definition is null

generateXSD

public java.lang.String generateXSD(oracle.jbo.server.ViewDefImpl viewDef,
                                    FlexfieldXSDGenerator.XsdRepos repos,
                                    java.util.Map<java.lang.String,java.lang.String> xsdNameToNamespaceMap)

Generates the XSD file for a view definition and a list of view link definitions.

Parameters:

viewDef - a view definition

repos - where the XSD files should be written to

xsdNameToNamespaceMap - the XSDs to be imported

Returns:

a reference to the generated XSD. The reference starts with a protocol such as "file://" or "mds://"

Throws:

java.lang.IllegalArgumentException - if the view def or location is null

BCModelerException - if an error occurs while creating the XSDs