org.onetwo.dbm.mapping.DbmMappedField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of onetwo-dbm Show documentation
onetwo-dbm
The newest version!
package org.onetwo.dbm.mapping;

import java.util.Collection;
import java.util.List;

import org.onetwo.common.utils.JFishProperty;
import org.onetwo.dbm.annotation.DbmJsonField;
import org.onetwo.dbm.event.spi.DbmEventAction;
import org.onetwo.dbm.id.IdentifierGenerator;
import org.onetwo.dbm.id.StrategyType;
import org.onetwo.dbm.jpa.GeneratedValueIAttrs;
import org.onetwo.dbm.mapping.version.VersionableType;

public interface DbmMappedField {

	IdentifierGenerator getIdGenerator();
	GeneratedValueIAttrs getGeneratedValueIAttrs();
	void addIdGenerator(IdentifierGenerator idGenerator);
	void setGeneratedValueIAttrs(GeneratedValueIAttrs generatedValueIAttrs);
	
	void setValue(Object entity, Object value);

	Object getValue(Object entity);
	
	/***
	 * 此方法会使用字段配置过的转换器对fieldValue进行转换，得到真实的字段值，一般用于存储
	 * @see DbmMappedField#getFieldValueConverter
	 * @param fieldValue
	 * @return
	 */
	Object getActualStoreValue(Object fieldValue);
	
	/***
	 * 此方法会使用字段配置过的转换器对fieldValue进行转换，得到真实的字段值，一般用于设置java对象
	 * @param fieldValue
	 * @return
	 */
	Object getActualJavaValue(Object fieldValue);

//	void setValueFromJdbc(Object entity, Object value);

//	Object getValueForJdbc(Object entity);
	
	List getFieldListeners();

	boolean isIdentify();

	void setIdentify(boolean identify);

	BaseColumnInfo getColumn();

	void setColumn(BaseColumnInfo column);

	String getName();

	DbmMappedEntry getEntry();

	String getLabel();

	void setLabel(String label);

	/********
	 * 自动生成值是否需要在插入之前fetch数据，一般就是oracle序列
	 * @return
	 */
//	boolean isGeneratedValueFetchBeforeInsert();

	boolean isGeneratedValue();

	boolean isSeqStrategy();

	boolean isIdentityStrategy();

	StrategyType getStrategyType();

	void setStrategyType(StrategyType strategyType);

	JFishProperty getPropertyInfo();
	
	/***
	 * 获取实际映射到类型
	 * @return
	 */
	Class getColumnType();

	void freezing();

	void checkFreezing(String name);

	boolean isFreezing();

	DbmMappedFieldType getMappedFieldType();

	void setMappedFieldType(DbmMappedFieldType mappedFieldType);

	boolean isJoinTableField();

//	DataHolder getDataHolder();
	
//	SqlParameterValue getValueForJdbcAndFireDbmEventAction(Object entity, JFishEventAction eventAction);
	/***
	 * 
	 * @param fieldValue
	 * @param eventAction
	 * @return newFieldValue
	 */
	Object fireDbmEntityFieldEvents(Object fieldValue, DbmEventAction eventAction);

	boolean isVersionControll();
	 VersionableType getVersionableType();
	void setVersionableType(VersionableType versionableType);
	
	boolean isEnumerated();
	boolean isEnumeratedOrdinal();
	
	DbmEnumType getEnumType();
//	GeneratedValueIAttrs getGeneratedValueIAttrs();
	
	DbmFieldValueConverter getFieldValueConverter();
	
	DbmJsonField getJsonFieldAnnotation();
	
	boolean isMappingGenerated();
	
	/***
	 * 获取绑定到此字段的所有字段
	 * @author weishao zeng
	 * @return
	 */
	Collection getBindedFields();

	/***
	 * 获取此字段绑定的字段
	 * @author weishao zeng
	 * @return
	 */
	DbmMappedField getBindToField();
	
	void setBindToField(DbmMappedField field);
	void setBindedFields(Collection fields);
	
}