com.bstek.dorado.config.definition

Class Definition

java.lang.Object

com.bstek.dorado.config.definition.Definition

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

EntityCollectionDefinition, ObjectDefinition

public abstract class Definition
extends java.lang.Object
implements java.lang.Cloneable

配置声明对象的抽象类。

配置声明对象即可用于保存配置文件的解析后得到的中间信息，也兼具利用这些配置信息生成最终对象的功能。

Since:

Mar 7, 2008

Author:

Benny Bao (mailto:benny.bao@bstek.com)

Constructor Summary

Constructors

Constructor and Description
Definition()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInitOperation(Operation operation) 添加一个初始化操作，该操作将在创建最终对象时被执行。
protected java.lang.Object	clone()
java.lang.Object	create(CreationContext context) 根据配置声明对象自身的定义创建最终对象。
java.lang.Object	create(CreationContext context, java.lang.Object[] constructorArgs) 根据配置声明对象自身的定义创建最终对象。
protected abstract java.lang.Object	doCreate(CreationContext context, java.lang.Object[] constuctorArgs)
protected void	executeInitOperations(java.lang.Object object, java.util.List<Operation> operations, CreationContext context) 执行一系列初始化操作。
Resource[]	getDependentResources()
java.util.List<Operation>	getInitOperations() 返回所有的初始化操作。
java.util.Map<java.lang.String,java.lang.Object>	getProperties() 返回最终对象的一组属性值。这些属性值将在创建对象时被初始化到新生成的对象中。 此方法返回值为Map集合，其中Map的键为属性名，值为相应的属性值。 需要注意的是，此处的属性值可能并不是真正的数值，它有可能是以下四种情况之一: 具体的数值。 EL表达式Expression。 配置声明对象Definition ，在最终初始化对象时将被转换成具体的数据或对象。 配置声明对象的引用 DefinitionReference ，在最终初始化对象时将被转换成具体的数据或对象。
java.lang.Object	getProperty(java.lang.String property)
Resource	getResource() 返回对象归属的文件资源。 归属的资源是指该对象定义在哪个配置文件中。 如果对象并非由配置文件产生，那么该方法将返回null。
protected void	initProperties(java.lang.Object object, java.util.Map<java.lang.String,java.lang.Object> properties, CreationContext context) 将一系列属性值初始化到给定的对象中。
java.lang.Object	removeProperty(java.lang.String property)
void	setDependentResources(Resource[] dependentResources)
protected void	setObjectProperty(java.lang.Object object, java.lang.String property, java.lang.Object value, CreationContext context) 将一个属性值初始化到给定的对象中。
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
void	setProperty(java.lang.String property, java.lang.Object value)
void	setResource(Resource resource) 设置对象归属的文件资源。

Methods inherited from class java.lang.Object

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

Constructor Detail

Definition

public Definition()

Method Detail

getResource

public Resource getResource()

返回对象归属的文件资源。
归属的资源是指该对象定义在哪个配置文件中。 如果对象并非由配置文件产生，那么该方法将返回null。

setResource

public void setResource(Resource resource)

设置对象归属的文件资源。

See Also:

getResource()

getDependentResources

public Resource[] getDependentResources()

Returns:

setDependentResources

public void setDependentResources(Resource[] dependentResources)

Parameters:

dependentResources -

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

返回最终对象的一组属性值。这些属性值将在创建对象时被初始化到新生成的对象中。
此方法返回值为Map集合，其中Map的键为属性名，值为相应的属性值。
需要注意的是，此处的属性值可能并不是真正的数值，它有可能是以下四种情况之一:

• 具体的数值。
• EL表达式Expression。
• 配置声明对象Definition ，在最终初始化对象时将被转换成具体的数据或对象。
• 配置声明对象的引用 DefinitionReference ，在最终初始化对象时将被转换成具体的数据或对象。

getProperty

public java.lang.Object getProperty(java.lang.String property)

setProperty

public void setProperty(java.lang.String property,
               java.lang.Object value)

removeProperty

public java.lang.Object removeProperty(java.lang.String property)

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

initProperties

protected void initProperties(java.lang.Object object,
                  java.util.Map<java.lang.String,java.lang.Object> properties,
                  CreationContext context)
                       throws java.lang.Exception

将一系列属性值初始化到给定的对象中。

Parameters:

object - 被初始化的对象。

properties - 属性值的集合。

context - 创建最终对象的上下文。

Throws:

java.lang.Exception

setObjectProperty

protected void setObjectProperty(java.lang.Object object,
                     java.lang.String property,
                     java.lang.Object value,
                     CreationContext context)
                          throws java.lang.Exception

将一个属性值初始化到给定的对象中。

Parameters:

object - 被初始化的对象。

property - 属性名。

value - 属性值。@see getProperties()

context - 创建最终对象的上下文。

Throws:

java.lang.Exception

addInitOperation

public void addInitOperation(Operation operation)

添加一个初始化操作，该操作将在创建最终对象时被执行。

Parameters:

operation - 初始化操作

getInitOperations

public java.util.List<Operation> getInitOperations()

返回所有的初始化操作。

See Also:

addInitOperation(Operation)

executeInitOperations

protected void executeInitOperations(java.lang.Object object,
                         java.util.List<Operation> operations,
                         CreationContext context)
                              throws java.lang.Exception

执行一系列初始化操作。

Parameters:

object - 被初始化的对象

operations - 初始化操作的集合

context - 创建最终对象的上下文

Throws:

java.lang.Exception

doCreate

protected abstract java.lang.Object doCreate(CreationContext context,
                        java.lang.Object[] constuctorArgs)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

create

public final java.lang.Object create(CreationContext context)
                              throws java.lang.Exception

根据配置声明对象自身的定义创建最终对象。

Parameters:

context - 创建最终对象的上下文

Returns:

最终对象

Throws:

java.lang.Exception

create

public final java.lang.Object create(CreationContext context,
                      java.lang.Object[] constructorArgs)
                              throws java.lang.Exception

根据配置声明对象自身的定义创建最终对象。

Parameters:

context - 创建最终对象的上下文

constructorArgs - 构造参数

Returns:

最终对象

Throws:

java.lang.Exception

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException