CMPFieldMetaData (JBoss Server API) - JBoss 3.2.7 server API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.ejb.plugins.jaws.metadata
Class CMPFieldMetaData

java.lang.Object
  org.jboss.metadata.MetaData
      org.jboss.ejb.plugins.jaws.metadata.CMPFieldMetaData

All Implemented Interfaces:: Cloneable, XmlLoadable

public class CMPFieldMetaData
extends MetaData
implements XmlLoadable

This class holds all the information jaws needs to know about a CMP field. It loads its data from standardjaws.xml and jaws.xml

Version:: $Revision: 1.14.4.1 $ Revison: 20010621 danch: merged patch from David Jenks - null constraint on columns.
Author:: Sebastien Alborini, Dirk Zimmermann, Vincent Harcq, David Jencks
See Also:

Field Summary

protected static org.jboss.logging.Logger log


Fields inherited from class org.jboss.metadata.MetaData

TX_MANDATORY, TX_NEVER, TX_NOT_SUPPORTED, TX_REQUIRED, TX_REQUIRES_NEW, TX_SUPPORTS, TX_UNKNOWN

Constructor Summary

CMPFieldMetaData(String name, JawsEntityMetaData jawsEntity)


Method Summary

String getColumnName()


Field getField()


Class getFieldType()
          We don't rely on the field alone for getting the type since we support nested field like 'data.categoryPK'.

static String getFirstComponent(String name)
          Returns the first component of a composite fieldName.

JawsEntityMetaData getJawsEntity()


int getJDBCType()


static String getLastComponent(String name)
          Returns the last component of a composite fieldName.

String getName()


String getNullable()


String getSQLType()


Object getValue(Object instance)
          Returns the value of this field.

void importXml(Element element)
          Imports either the jboss or ejb-jar from the given element.

boolean isAPrimaryKeyField()


boolean isEJBReference()


boolean isNested()


void set(Object instance, Object value)
          Is used mainly for nested fields.

Methods inherited from class org.jboss.metadata.MetaData

clone, getChildrenByTagName, getElementAttribute, getElementContent, getElementContent, getFirstElementContent, getOptionalChild, getOptionalChild, getOptionalChildBooleanContent, getOptionalChildContent, getUniqueChild, getUniqueChildContent, importEjbJarXml, importJbossXml, jdk13Enabled

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.jboss.logging.Logger log

Constructor Detail

CMPFieldMetaData

public CMPFieldMetaData(String name,
                        JawsEntityMetaData jawsEntity)
                 throws org.jboss.deployment.DeploymentException

Method Detail

getName

public String getName()

getField

public Field getField()

getJDBCType

public int getJDBCType()

getSQLType

public String getSQLType()

getNullable

public String getNullable()

getColumnName

public String getColumnName()

isEJBReference

public boolean isEJBReference()

isAPrimaryKeyField

public boolean isAPrimaryKeyField()

getJawsEntity

public JawsEntityMetaData getJawsEntity()

getLastComponent

public static String getLastComponent(String name)

Returns the last component of a composite fieldName. E.g., for "data.categoryPK" it will return "categoryPK".

getFirstComponent

public static String getFirstComponent(String name)

Returns the first component of a composite fieldName. E.g., for "data.categoryPK" it will return "data".

getFieldType

public Class getFieldType()

We don't rely on the field alone for getting the type since we support nested field like 'data.categoryPK'.

set

public void set(Object instance,
                Object value)

Is used mainly for nested fields. Sets the value of a nested field.

getValue

public Object getValue(Object instance)

Returns the value of this field.

isNested

public boolean isNested()

importXml

public void importXml(Element element)
               throws org.jboss.deployment.DeploymentException

Description copied from class: MetaData

Imports either the jboss or ejb-jar from the given element.

Specified by:: importXml in interface XmlLoadable
Overrides:: importXml in class MetaData

Parameters:: element - The element to import.
Throws:: org.jboss.deployment.DeploymentException - Unrecognized root tag.