com.att.ajsc.csilogging.util

Interface RuntimeTIG

public interface RuntimeTIG

There are certain elements of TypeInfoGroup we want at runtime, but we want to remove all intermediary HashMaps, etc to save Memory once in Runtime Mode. These methods are safe at runtime.

Method Summary

Modifier and Type	Method and Description
String	classNameForElement(QName qname) Given a specified QName, M2E has the smarts to identify and return its underlying class.
String	getPkgFromNS(String namespace) Obtains the Java Package M2E will use based on Schema targetNamespace.
QName	getRealQName(Class<?> cls) Deprecated.
void	loadCompiled(String xsdRootDir, Reader in) Load up the pre-compiled information into maps that support these calls.

Method Detail

getPkgFromNS

String getPkgFromNS(String namespace)

Obtains the Java Package M2E will use based on Schema targetNamespace. The least standardized piece of Schema in JAXB compiling is how the class names will be created. Several "goofy" conventions include using "http://". Of course, it's not a URI, but most programmers would think it is a URI, so to prevent someone from attempting to actually use it as a URI, they code any "dots" inside "path" backwards. i.e. "http://csi.cingular.com/CSI..." However, it has become a convention if you end up using "http" in your namespace. On the other hand, there is actually no reason to put "http://" in your namespace, and other nicer "conventions" have arisen, including using "java:com.cingular.csi", which actually looks like a java path, and just "com.cingular.csi", which is just as valid. There is no telling what kind of additional "goofiness" will be found in the company and vendors of ATT,so we reserve the ability to code this within M2E in a convenient place.

Parameters:

namespace - The namespace used to derive the Java package name.

Returns:

The M2E Java package associated with the supplied namespace.

getRealQName

@Deprecated
QName getRealQName(Class<?> cls)

Deprecated.

Class names aren't actually QNames, but under certain circumstances JAXB requires the use of QName to marshall an object out to a String. M2E analyzes the Schemas and saves off what QNames go with what Classes in an attempt to avoid these issues. However, it still is not always 100% safe.

Parameters:

cls - The class name used to return the QName from the RuntimeTIG.

Returns:

The QName associated with the supplied class name in the RuntimeTIG.

classNameForElement

String classNameForElement(QName qname)

Given a specified QName, M2E has the smarts to identify and return its underlying class.

Parameters:

qname - The QName for the associated class we want to derive.

Returns:

The class name corresponding to the supplied QName.

loadCompiled

void loadCompiled(String xsdRootDir,
                  Reader in)
           throws IOException

Load up the pre-compiled information into maps that support these calls. While schemas are not fully used by this class, the Schemas may be required for runtime validation. Thus, the schema Dir is where the system can find the start of the schema libraries.

Parameters:

xsdRootDir - The schema root directory.

in - The Reader containing the pre-compiled data.

Throws:

IOException - Thrown if the pre-compiled data cannot be loaded properly into runtime objects.