|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.introspection.XmlIiGenerator
wt.introspection.XmlClassIiGenerator
Produces reports for the set of classes whose names are provided in a String array.
Fields inherited from class wt.introspection.XmlIiGenerator |
directory, ENUMERATED_TYPE, ignoreProblems, modelRegistry, outputDirectory, printReport, suffix, WINDCHILL_CLASS |
Constructor Summary | |
|
XmlClassIiGenerator(String class_name)
Create an instance to produce a report for the specified class. |
(package private) |
XmlClassIiGenerator(String class_name,
XmlIiGenerator parent)
|
Method Summary | |
private ClassInfo |
classInfo()
|
private Element |
classInfoElement()
|
private String |
classPartOf(String fully_qualified_class_name)
Return just the class name part of the fully qualified class name. |
private void |
clearResultHoldersIfNecessary()
|
private void |
createValueElement(Element parent_element,
String attribute_name,
Object value)
Create an element for property descriptor value with the given name and value. |
private Document |
document()
|
private void |
exerciseAttributeInfo(AttributeDescriptor[] attrs)
Exercise the methods of the AttributeDescriptors. |
private void |
exerciseClassInfo()
Exercise the methods of the ClassInfo class. |
private void |
exerciseColumnInfo(ColumnDescriptor attr,
Element parent_element,
boolean in_view)
Exercise the methods of the ColumnDescriptor. |
private void |
exerciseColumnInfos(ColumnDescriptor[] attrs,
Element parent_element,
boolean in_view)
Exercise the methods of the ColumnDescriptors. |
private void |
exerciseCriteria(CriteriaDescriptor[] criteria,
Element parent_element)
Exercise the methods of the CriteriaDescriptors. |
private void |
exerciseCriterion(CriteriaDescriptor criterion,
int number,
Element parent_element)
Exercise the methods of the CriteriaDescriptor. |
private void |
exerciseDatabaseInfo(DatabaseInfo dbInfo)
Exercise the methods of the ClassInfo class. |
private void |
exerciseLinkInfo()
Exercise the methods of the LinkInfo class. |
private void |
exercisePropertyInfo(PropertyDescriptor property,
Element parent_element)
Exercise the methods of the PropertyDescriptor. |
private void |
exercisePropertyInfos(PropertyDescriptor[] properties,
Element parent_element)
Exercise the methods of the PropertyDescriptors. |
private void |
exerciseRoleInfo(RoleDescriptor role,
Element parent_element,
String role_side_name)
Exercise the methods of the RoleDescriptor. |
private void |
exerciseRoleInfos(RoleDescriptor[] roles,
Element parent_element,
String role_side_name)
Exercise an array of RoleDescriptors. |
String |
getClassName()
The name of the class for which the generator will produce a report. |
private void |
initResultHoldersFor(ClassInfo class_info)
|
private ClassInfo |
lookupClassInfoFor(String full_class_name)
|
private String |
packagePartOf(String fully_qualified_class_name)
Return just the package part of the fully qualified class name. |
private void |
printReportIfNecessary()
|
void |
process()
Process the class, producing a report if necessary. |
private void |
reportErrorOrThrow(Throwable t,
String context_description)
If not in ignore mode, then re-throw the Throwable. |
private void |
reportErrorOrThrow(Throwable t,
String context_description,
Element parent_element)
If not in ignore mode, then re-throw the Throwable. |
private void |
setAttribute(Element elem,
String attribute_name,
String value)
Set the attribute with the provided name and value on the specified element. |
private void |
setAttribute(Element elem,
String attribute_name,
String value,
String[] to_exclude)
Set the attribute with the provided name and value on the specified element excluding certain values Values of null or "null" OR any of the values provided in the string array will result in no attribute being set. |
Methods inherited from class wt.introspection.XmlIiGenerator |
getOutputDirectory, isIntrospectable, main, newDocument, print, print, report, setDirectory, setIgnoreProblems, setOutputDirectory, setPrintReport, setSuffix, tail, writeDocument |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String ALIASED_CLASS_ELEM_NAME
public static final String CLASS_INFO_ELEM_NAME
public static final String COLUMN_ELEM_NAME
public static final String COLUMN_REF_ELEM_NAME
public static final String CRITERION_ELEM_NAME
public static final String DB_COLUMN_NAME_ELEM_NAME
public static final String DB_COMP_INDEX_ELEM_NAME
public static final String DESCENDANT_ELEM_NAME
public static final String DISPLAY_NAME_ELEM_NAME
public static final String ERROR_ELEM_NAME
public static final String INTERFACE_ELEM_NAME
public static final String LINK_INFO_ELEM_NAME
public static final String PROPERTY_ELEM_NAME
public static final String ROLE_ALIAS_ELEM_NAME
public static final String ROLE_ELEM_NAME
public static final String SHORT_DESCRIPTION_ELEM_NAME
public static final String VIEW_ELEM_NAME
public static final String ALIASED_ROLE_NAME_ATTR_NAME
public static final String CARDINALITY_ATTR_NAME
public static final String CLASS_NAME_ATTR_NAME
public static final String BUSINESS_CLASS_ATTR_NAME
public static final String COLUMN_NAME_1_ATTR_NAME
public static final String COLUMN_NAME_2_ATTR_NAME
public static final String CONCRETE_CLASS_ATTR_NAME
public static final String DB_INDEX_TABLE_SPACE_ATTR_NAME
public static final String DB_IS_AUTO_NAVIGATE_ATTR_NAME
public static final String DB_PACKAGE_NAME_ATTR_NAME
public static final String DB_TABLE_NAME_ATTR_NAME
public static final String DB_TABLE_SPACE_ATTR_NAME
public static final String DB_TABLE_SIZE_ATTR_NAME
public static final String ERROR_DESCRIPTION_ATTR_NAME
public static final String EXTERNALIZATION_VERSION_UID_ATTR_NAME
public static final String INDEXED_PROP_TYPE_ATTR_NAME
public static final String INDEXED_READ_METHOD_ATTR_NAME
public static final String INDEXED_WRITE_METHOD_ATTR_NAME
public static final String IS_AGGREGATED_ATTR_NAME
public static final String IS_ATTRIBUTED_ATTR_NAME
public static final String IS_AUTO_NAVIGATE_ATTR_NAME
public static final String IS_BOUND_ATTR_NAME
public static final String IS_COMPOSED_ATTR_NAME
public static final String IS_CONCRETE_ATTR_NAME
public static final String IS_CONSTRAINED_ATTR_NAME
public static final String IS_DEPENDENCY_ATTR_NAME
public static final String IS_DERIVED_ATTR_NAME
public static final String IS_DIRECT_DESCENDANT_ATTR_NAME
public static final String IS_EXPERT_ATTR_NAME
public static final String IS_HIDDEN_ATTR_NAME
public static final String IS_INDEXED_ATTR_NAME
public static final String IS_LINK_TABLE_ATTR_NAME
public static final String IS_MULTIPLE_ATTR_NAME
public static final String IS_NAVIGABLE_ATTR_NAME
public static final String IS_OPTIONAL_ATTR_NAME
public static final String IS_PERSISTABLE_ATTR_NAME
public static final String IS_REQUIRED_ATTR_NAME
public static final String IS_UNBOUNDED_ATTR_NAME
public static final String IS_UNIQUE_ATTR_NAME
public static final String IS_UPDATABLE_ATTR_NAME
public static final String JAVA_TYPE_ATTR_NAME
public static final String LENGTH_ATTR_NAME
public static final String LINK_INFO_ATTR_NAME
public static final String LOCALE_ATTR_NAME
public static final String NAME_ATTR_NAME
public static final String NUMBER_ATTR_NAME
public static final String OPEN_ICON_ATTR_NAME
public static final String OPERATOR_ATTR_NAME
public static final String OTHER_ROLE_ATTR_NAME
public static final String PACKAGE_NAME_ATTR_NAME
public static final String PARENT_CLASS_ATTR_NAME
public static final String PROPERTY_TYPE_ATTR_NAME
public static final String QUERY_NAME_ATTR_NAME
public static final String READ_METHOD_ATTR_NAME
public static final String REFERENCE_NAME_ATTR_NAME
public static final String REFERENCE_TYPE_ATTR_NAME
public static final String ROLE_SIDE_ATTR_NAME
public static final String SERIAL_VERSION_UID_ATTR_NAME
public static final String SERIALIZABLE_TYPE_ATTR_NAME
public static final String SQL_TYPE_ATTR_NAME
public static final String STANDARD_ICON_ATTR_NAME
public static final String TABLE_ALIAS_ATTR_NAME
public static final String TABLE_NAME_1_ATTR_NAME
public static final String TABLE_NAME_2_ATTR_NAME
public static final String VALID_CLASS_INFO_ATTR_NAME
public static final String WRITE_METHOD_ATTR_NAME
private String className_
private ClassInfo classInfo_
private boolean ignoreLinkageErrors_
private Document classInfoDocument_
private Element classInfoElement_
Constructor Detail |
public XmlClassIiGenerator(String class_name)
XmlClassIiGenerator(String class_name, XmlIiGenerator parent)
Method Detail |
public String getClassName()
private ClassInfo classInfo()
private Document document()
private Element classInfoElement()
private void initResultHoldersFor(ClassInfo class_info)
private void clearResultHoldersIfNecessary()
private String classPartOf(String fully_qualified_class_name)
fully_qualified_class_name
- a fully qualified class name
private String packagePartOf(String fully_qualified_class_name)
fully_qualified_class_name
- a fully qualified class name
private void createValueElement(Element parent_element, String attribute_name, Object value)
parent_element
- the element to append the value element to as a childattribute_name
- the property value name/keyvalue
- the property value; will be converted to a string via toString()
private void setAttribute(Element elem, String attribute_name, String value)
private void setAttribute(Element elem, String attribute_name, String value, String[] to_exclude)
public final void process() throws WTIntrospectionException
process
in class XmlIiGenerator
WTIntrospectionException
private ClassInfo lookupClassInfoFor(String full_class_name) throws WTIntrospectionException, IOException
full_class_name
- a fully-qualified Java class name
WTIntrospectionException
- if a non-ignorable error crops up and we are not in ignore mode
IOException
private void printReportIfNecessary()
private void exerciseClassInfo() throws WTIntrospectionException
WTIntrospectionException
private void exerciseRoleInfos(RoleDescriptor[] roles, Element parent_element, String role_side_name) throws WTIntrospectionException
roles
- an array of role descriptors to exerciseparent_element
- the parent element to append the role element torole_side_name
- the side of the roles relative to the bearer of the role
WTIntrospectionException
- if there is an error accesing any of the roles' link infos, valid class infos, or other sidesprivate void exerciseRoleInfo(RoleDescriptor role, Element parent_element, String role_side_name) throws WTIntrospectionException
role
- role descriptor to exerciseparent_element
- the parent element to append the role element torole_side_name
- the side of the role relative to the bearer of the role
WTIntrospectionException
- if there is an error accesing the role's link info, valid class info, or other sideprivate void exerciseAttributeInfo(AttributeDescriptor[] attrs)
attrs
- is array of descriptors to exerciseprivate void exercisePropertyInfos(PropertyDescriptor[] properties, Element parent_element) throws WTIntrospectionException
properties
- an array of descriptors to exercise
WTIntrospectionException
- if there is a problem accessing the database info to report the properties' columnsprivate void exercisePropertyInfo(PropertyDescriptor property, Element parent_element) throws WTIntrospectionException
property
- a descriptor to exercise
WTIntrospectionException
- if there is a problem accessing the database info to report the property's columnsprivate void exerciseDatabaseInfo(DatabaseInfo dbInfo) throws WTIntrospectionException
WTIntrospectionException
private void exerciseColumnInfos(ColumnDescriptor[] attrs, Element parent_element, boolean in_view)
attrs
- an array of descriptors to exerciseparent_element
- the parent element to append the column descriptor elements toprivate void exerciseColumnInfo(ColumnDescriptor attr, Element parent_element, boolean in_view)
attr
- the descriptor to exerciseparent_element
- the parent element to append the column descriptor element toprivate void exerciseLinkInfo() throws WTIntrospectionException
WTIntrospectionException
private void exerciseCriterion(CriteriaDescriptor criterion, int number, Element parent_element)
private void exerciseCriteria(CriteriaDescriptor[] criteria, Element parent_element)
criteria
- is array of descriptors to exerciseprivate void reportErrorOrThrow(Throwable t, String context_description) throws WTIntrospectionException
t
- the Throwablecontext_description
- a description of the context in which the error occurred
WTIntrospectionException
- if not in ignore mode; the Throwable will be wrapped inside this type of exception if necessaryprivate void reportErrorOrThrow(Throwable t, String context_description, Element parent_element) throws WTIntrospectionException
t
- the Throwablecontext_description
- a description of the context in which the error occurredparent_element
- the parent DOM element to add the error message element to
WTIntrospectionException
- if not in ignore mode; the Throwable will be wrapped inside this type of exception if necessary
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |