org.scrashmeow.ojb.console.service
Interface MetaDataService

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

MetaDataServiceImpl

public interface MetaDataService

extends java.io.Serializable

The MetaData Service. This service provides a view into the meta data of OJB.

Author:

Alexander Bibighaus

Method Summary

void	addIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld, java.lang.Object obj, java.lang.Object nested) Method addIndexedFieldValue @add-javadoc!!!
java.lang.String	buildFormElementName(org.apache.ojb.broker.metadata.FieldDescriptor fld) Method buildFormElementName @add-javadoc!!!
java.lang.String	buildMappedFormElementName(java.lang.String mapName, org.apache.ojb.broker.metadata.FieldDescriptor fld) Method buildMappedFormElementName @add-javadoc!!!
java.util.Collection	createCollectionInstance(org.apache.ojb.broker.metadata.CollectionDescriptor colld) Method createCollectionInstance @add-javadoc!!!
java.util.Collection	createDefaultCollectionInstance() Method createDefaultCollectionInstance @add-javadoc!!!
java.lang.Object	createInstance(org.apache.ojb.broker.metadata.ClassDescriptor cld) Method createInstance @add-javadoc!!!
org.apache.ojb.broker.metadata.ClassDescriptor	findClassDescriptor(java.lang.Class clazz) Method findClassDescriptor @add-javadoc!!!
org.apache.ojb.broker.metadata.ClassDescriptor	findClassDescriptor(java.lang.String fullClassName) Method findClassDescriptor @add-javadoc!!!
java.util.Collection	findClassDescriptors(java.util.Collection fullClassName) Method findClassDescriptors @add-javadoc!!!
org.apache.ojb.broker.metadata.ClassDescriptor[]	findClassDescriptors(java.lang.String[] fullClassName) Method findClassDescriptors @add-javadoc!!!
org.apache.ojb.broker.metadata.ClassDescriptor	findCollectionClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.String collectionName) Method findCollectionClassDescriptor @add-javadoc!!!
org.apache.ojb.broker.metadata.JdbcConnectionDescriptor	findDefaultJdbcConnectionDescriptor()
java.lang.String	findDefaultJdbcConnectionDescriptorAlias() Method findDefaultJdbcConnectionDescriptorAlias @add-javadoc!!!
org.apache.ojb.broker.metadata.FieldDescriptor	findFieldDescriptorByColumName(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.String fullColumnName) Method findFieldDescriptorByColumName @add-javadoc!!!
org.apache.ojb.broker.metadata.JdbcConnectionDescriptor	findJdbcConnectionDescriptor(java.lang.String jcdAlias) Method findJdbcConnectionDescriptor @add-javadoc!!!
java.util.Collection	findJdbcConnectionDescriptors() Method findJdbcConnectionDescriptors @add-javadoc!!!
org.apache.ojb.broker.metadata.ClassDescriptor	findReferenceClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.String referenceName) Method findReferenceClassDescriptor @add-javadoc!!!
java.util.Collection	findUniqueJdbcConnectionDescriptorAliases() Method findUniqueJdbcConnectionDescriptorAliases @add-javadoc!!!
java.util.Collection	getClassDescriptorIds() Method getClassDescriptorIds @add-javadoc!!!
java.util.Collection	getClassDescriptors() Method getClassDescriptors @add-javadoc!!!
org.apache.ojb.broker.metadata.ConnectionRepository	getConnectionRepositoryDescriptor() Method getConnectionRepositoryDescriptor @add-javadoc!!!
org.apache.ojb.broker.PBKey	getDefaultPBKey() Method getDefaultPBKey @add-javadoc!!!
java.lang.Object	getFieldValue(org.apache.ojb.broker.metadata.AttributeDescriptorBase fld, java.lang.Object obj) Method getFieldValue @add-javadoc!!!
java.lang.Object	getIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld, java.lang.Object obj, int index) Method getIndexedFieldValue @add-javadoc!!!
java.util.Collection	getLeafClassDescriptorIds() Method getLeafClassDescriptorIds @add-javadoc!!!
java.util.Collection	getLeafClassDescriptors() Method getLeafClassDescriptors @add-javadoc!!!
java.util.Properties	getOjbProperties() Method getOjbProperties @add-javadoc!!!
java.lang.Object[]	getPkFieldValues(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.Object obj) Method getPkFieldValues @add-javadoc!!!
java.lang.Object[]	getPkValues(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.Object obj) Method getPkValues @add-javadoc!!!
java.util.Map	getPropertiesForClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor desc) Method getPropertiesForClassDescriptor @add-javadoc!!!
java.util.Map	getPropertiesForFieldDescriptor(org.apache.ojb.broker.metadata.FieldDescriptor desc) Method getPropertiesForFieldDescriptor @add-javadoc!!!
java.util.Map	getPropertiesForJdbcConnectionDescriptor(org.apache.ojb.broker.metadata.JdbcConnectionDescriptor jdbcDesc) Method getPropertiesForJdbcConnectionDescriptor @add-javadoc!!!
java.util.Map	getPropertiesForRepositoryDescriptor(org.apache.ojb.broker.metadata.DescriptorRepository desc) Method getPropertiesForRepositoryDescriptor @add-javadoc!!!
org.apache.ojb.broker.metadata.DescriptorRepository	getRepositoryDescriptor() Method getRepositoryDescriptor @add-javadoc!!!
java.lang.String	getRepositoryXML()
java.lang.String	getTypeNameFromJDBCType(int jdbcType) Method getTypeNameFromJDBCType @add-javadoc!!!
java.lang.String	getVersion() Method getVersion @add-javadoc!!!
void	setFieldValue(org.apache.ojb.broker.metadata.AttributeDescriptorBase fld, java.lang.Object obj, java.lang.Object value) Method setFieldValue @add-javadoc!!!
void	setIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld, java.lang.Object obj, int index, java.lang.Object nested) Method setIndexedFieldValue @add-javadoc!!!
void	verifyRepository(java.util.Collection errors, java.util.Collection warnings, java.util.Collection verifyLog)
void	verifyRepository(org.apache.ojb.broker.PBKey key, boolean validateXML, boolean useStrictTypeChecking, boolean ignoreFieldNameCase, java.util.Collection errors, java.util.Collection warnings, java.util.Collection verifyLog)

Method Detail

setFieldValue

public void setFieldValue(org.apache.ojb.broker.metadata.AttributeDescriptorBase fld,
                          java.lang.Object obj,
                          java.lang.Object value)
                   throws ServiceException

Method setFieldValue @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

obj - @add-javadoc!!!

value - @add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getFieldValue

public java.lang.Object getFieldValue(org.apache.ojb.broker.metadata.AttributeDescriptorBase fld,
                                      java.lang.Object obj)
                               throws ServiceException

Method getFieldValue @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

obj - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getIndexedFieldValue

public java.lang.Object getIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld,
                                             java.lang.Object obj,
                                             int index)
                                      throws ServiceException

Method getIndexedFieldValue @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

obj - @add-javadoc!!!

index - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

setIndexedFieldValue

public void setIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld,
                                 java.lang.Object obj,
                                 int index,
                                 java.lang.Object nested)
                          throws ServiceException

Method setIndexedFieldValue @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

obj - @add-javadoc!!!

index - @add-javadoc!!!

nested - @add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

addIndexedFieldValue

public void addIndexedFieldValue(org.apache.ojb.broker.metadata.CollectionDescriptor fld,
                                 java.lang.Object obj,
                                 java.lang.Object nested)
                          throws ServiceException

Method addIndexedFieldValue @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

obj - @add-javadoc!!!

nested - @add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPkFieldValues

public java.lang.Object[] getPkFieldValues(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                           java.lang.Object obj)
                                    throws ServiceException

Method getPkFieldValues @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

obj - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPkValues

public java.lang.Object[] getPkValues(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                      java.lang.Object obj)
                               throws ServiceException

Method getPkValues @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

obj - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createInstance

public java.lang.Object createInstance(org.apache.ojb.broker.metadata.ClassDescriptor cld)
                                throws ServiceException

Method createInstance @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createCollectionInstance

public java.util.Collection createCollectionInstance(org.apache.ojb.broker.metadata.CollectionDescriptor colld)
                                              throws ServiceException

Method createCollectionInstance @add-javadoc!!!

Parameters:

colld - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createDefaultCollectionInstance

public java.util.Collection createDefaultCollectionInstance()
                                                     throws ServiceException

Method createDefaultCollectionInstance @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getRepositoryDescriptor

public org.apache.ojb.broker.metadata.DescriptorRepository getRepositoryDescriptor()
                                                                            throws ServiceException

Method getRepositoryDescriptor @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findCollectionClassDescriptor

public org.apache.ojb.broker.metadata.ClassDescriptor findCollectionClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                                                                    java.lang.String collectionName)
                                                                             throws ServiceException

Method findCollectionClassDescriptor @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

collectionName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findReferenceClassDescriptor

public org.apache.ojb.broker.metadata.ClassDescriptor findReferenceClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                                                                   java.lang.String referenceName)
                                                                            throws ServiceException

Method findReferenceClassDescriptor @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

referenceName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findClassDescriptor

public org.apache.ojb.broker.metadata.ClassDescriptor findClassDescriptor(java.lang.String fullClassName)
                                                                   throws ServiceException

Method findClassDescriptor @add-javadoc!!!

Parameters:

fullClassName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findClassDescriptors

public org.apache.ojb.broker.metadata.ClassDescriptor[] findClassDescriptors(java.lang.String[] fullClassName)
                                                                      throws ServiceException

Method findClassDescriptors @add-javadoc!!!

Parameters:

fullClassName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findClassDescriptors

public java.util.Collection findClassDescriptors(java.util.Collection fullClassName)
                                          throws ServiceException

Method findClassDescriptors @add-javadoc!!!

Parameters:

fullClassName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findClassDescriptor

public org.apache.ojb.broker.metadata.ClassDescriptor findClassDescriptor(java.lang.Class clazz)
                                                                   throws ServiceException

Method findClassDescriptor @add-javadoc!!!

Parameters:

clazz - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getConnectionRepositoryDescriptor

public org.apache.ojb.broker.metadata.ConnectionRepository getConnectionRepositoryDescriptor()
                                                                                      throws ServiceException

Method getConnectionRepositoryDescriptor @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findFieldDescriptorByColumName

public org.apache.ojb.broker.metadata.FieldDescriptor findFieldDescriptorByColumName(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                                                                     java.lang.String fullColumnName)
                                                                              throws ServiceException

Method findFieldDescriptorByColumName @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

fullColumnName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findUniqueJdbcConnectionDescriptorAliases

public java.util.Collection findUniqueJdbcConnectionDescriptorAliases()
                                                               throws ServiceException

Method findUniqueJdbcConnectionDescriptorAliases @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findDefaultJdbcConnectionDescriptorAlias

public java.lang.String findDefaultJdbcConnectionDescriptorAlias()
                                                          throws ServiceException

Method findDefaultJdbcConnectionDescriptorAlias @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findJdbcConnectionDescriptors

public java.util.Collection findJdbcConnectionDescriptors()
                                                   throws ServiceException

Method findJdbcConnectionDescriptors @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findJdbcConnectionDescriptor

public org.apache.ojb.broker.metadata.JdbcConnectionDescriptor findJdbcConnectionDescriptor(java.lang.String jcdAlias)
                                                                                     throws ServiceException

Method findJdbcConnectionDescriptor @add-javadoc!!!

Parameters:

jcdAlias - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getClassDescriptors

public java.util.Collection getClassDescriptors()
                                         throws ServiceException

Method getClassDescriptors @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getClassDescriptorIds

public java.util.Collection getClassDescriptorIds()
                                           throws ServiceException

Method getClassDescriptorIds @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getLeafClassDescriptors

public java.util.Collection getLeafClassDescriptors()
                                             throws ServiceException

Method getLeafClassDescriptors @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getLeafClassDescriptorIds

public java.util.Collection getLeafClassDescriptorIds()
                                               throws ServiceException

Method getLeafClassDescriptorIds @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

buildFormElementName

public java.lang.String buildFormElementName(org.apache.ojb.broker.metadata.FieldDescriptor fld)
                                      throws ServiceException

Method buildFormElementName @add-javadoc!!!

Parameters:

fld - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

buildMappedFormElementName

public java.lang.String buildMappedFormElementName(java.lang.String mapName,
                                                   org.apache.ojb.broker.metadata.FieldDescriptor fld)
                                            throws ServiceException

Method buildMappedFormElementName @add-javadoc!!!

Parameters:

mapName - @add-javadoc!!!

fld - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getVersion

public java.lang.String getVersion()
                            throws ServiceException

Method getVersion @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getOjbProperties

public java.util.Properties getOjbProperties()
                                      throws ServiceException

Method getOjbProperties @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getDefaultPBKey

public org.apache.ojb.broker.PBKey getDefaultPBKey()
                                            throws ServiceException

Method getDefaultPBKey @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPropertiesForJdbcConnectionDescriptor

public java.util.Map getPropertiesForJdbcConnectionDescriptor(org.apache.ojb.broker.metadata.JdbcConnectionDescriptor jdbcDesc)
                                                       throws ServiceException

Method getPropertiesForJdbcConnectionDescriptor @add-javadoc!!!

Parameters:

jdbcDesc - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPropertiesForRepositoryDescriptor

public java.util.Map getPropertiesForRepositoryDescriptor(org.apache.ojb.broker.metadata.DescriptorRepository desc)
                                                   throws ServiceException

Method getPropertiesForRepositoryDescriptor @add-javadoc!!!

Parameters:

desc - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPropertiesForClassDescriptor

public java.util.Map getPropertiesForClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor desc)
                                              throws ServiceException

Method getPropertiesForClassDescriptor @add-javadoc!!!

Parameters:

desc - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getPropertiesForFieldDescriptor

public java.util.Map getPropertiesForFieldDescriptor(org.apache.ojb.broker.metadata.FieldDescriptor desc)
                                              throws ServiceException

Method getPropertiesForFieldDescriptor @add-javadoc!!!

Parameters:

desc - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getTypeNameFromJDBCType

public java.lang.String getTypeNameFromJDBCType(int jdbcType)
                                         throws ServiceException

Method getTypeNameFromJDBCType @add-javadoc!!!

Parameters:

jdbcType - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

findDefaultJdbcConnectionDescriptor

public org.apache.ojb.broker.metadata.JdbcConnectionDescriptor findDefaultJdbcConnectionDescriptor()
                                                                                            throws ServiceException

ServiceException

verifyRepository

public void verifyRepository(java.util.Collection errors,
                             java.util.Collection warnings,
                             java.util.Collection verifyLog)
                      throws ServiceException

ServiceException

verifyRepository

public void verifyRepository(org.apache.ojb.broker.PBKey key,
                             boolean validateXML,
                             boolean useStrictTypeChecking,
                             boolean ignoreFieldNameCase,
                             java.util.Collection errors,
                             java.util.Collection warnings,
                             java.util.Collection verifyLog)
                      throws ServiceException

ServiceException

getRepositoryXML

public java.lang.String getRepositoryXML()
                                  throws ServiceException

ServiceException