This is an automated email from the ASF dual-hosted git repository.
doebele pushed a commit to branch version3
in repository https://gitbox.apache.org/repos/asf/empire-db.git
The following commit(s) were added to refs/heads/version3 by this push:
new 3301fe7 EMPIREDB-362 Interface cleanup (4) Some renaming
3301fe7 is described below
commit 3301fe7b82f75b9f28ab7bd07d5ee9ac500a4dde
Author: Rainer Döbele <[email protected]>
AuthorDate: Sun Feb 13 20:59:49 2022 +0100
EMPIREDB-362 Interface cleanup (4) Some renaming
---
.../empire/data/{Entity.java => EntityType.java} | 4 ++--
.../main/java/org/apache/empire/data/Record.java | 2 +-
.../org/apache/empire/data/bean/BeanClass.java | 6 ++---
.../apache/empire/data/bean/BeanRecordProxy.java | 26 +++++++++++-----------
.../org/apache/empire/data/list/DataListEntry.java | 10 ++++-----
.../java/org/apache/empire/db/DBRecordBase.java | 4 ++--
.../java/org/apache/empire/db/DBRecordData.java | 6 ++---
.../main/java/org/apache/empire/db/DBRowSet.java | 8 +++----
.../empire/db/exceptions/RecordException.java | 24 ++++++++++----------
.../db/exceptions/RecordReadOnlyException.java | 2 +-
10 files changed, 46 insertions(+), 46 deletions(-)
diff --git a/empire-db/src/main/java/org/apache/empire/data/Entity.java
b/empire-db/src/main/java/org/apache/empire/data/EntityType.java
similarity index 75%
rename from empire-db/src/main/java/org/apache/empire/data/Entity.java
rename to empire-db/src/main/java/org/apache/empire/data/EntityType.java
index ea5d865..4cf5022 100644
--- a/empire-db/src/main/java/org/apache/empire/data/Entity.java
+++ b/empire-db/src/main/java/org/apache/empire/data/EntityType.java
@@ -2,9 +2,9 @@ package org.apache.empire.data;
import java.util.List;
-public interface Entity
+public interface EntityType
{
- String getName();
+ String getEntityName();
List<? extends Column> getColumns();
diff --git a/empire-db/src/main/java/org/apache/empire/data/Record.java
b/empire-db/src/main/java/org/apache/empire/data/Record.java
index 4efeca1..fca7fc8 100644
--- a/empire-db/src/main/java/org/apache/empire/data/Record.java
+++ b/empire-db/src/main/java/org/apache/empire/data/Record.java
@@ -93,7 +93,7 @@ public interface Record extends RecordData
* Returns the entity this Record belongs to
* @return the entity
*/
- Entity getEntity();
+ EntityType getEntityType();
/**
* returns true if the field is visible to the client.
diff --git a/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
b/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
index d945199..ccdaf88 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
@@ -24,7 +24,7 @@ import java.util.List;
import org.apache.empire.data.Column;
import org.apache.empire.data.DataType;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
/**
* BeanObject
@@ -33,7 +33,7 @@ import org.apache.empire.data.Entity;
* A metadata definition consists primarily of the class name and a list of
properties.
* @author Rainer
*/
-public abstract class BeanClass implements Entity
+public abstract class BeanClass implements EntityType
{
private final String name;
private final List<BeanProperty> properties = new
ArrayList<BeanProperty>();
@@ -103,7 +103,7 @@ public abstract class BeanClass implements Entity
* @return the class name
*/
@Override
- public String getName()
+ public String getEntityName()
{
return name;
}
diff --git
a/empire-db/src/main/java/org/apache/empire/data/bean/BeanRecordProxy.java
b/empire-db/src/main/java/org/apache/empire/data/bean/BeanRecordProxy.java
index a4a5134..94adada 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanRecordProxy.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanRecordProxy.java
@@ -30,7 +30,7 @@ import org.apache.empire.commons.ObjectUtils;
import org.apache.empire.commons.Options;
import org.apache.empire.data.Column;
import org.apache.empire.data.ColumnExpr;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
import org.apache.empire.data.Record;
import org.apache.empire.exceptions.BeanPropertyGetException;
import org.apache.empire.exceptions.BeanPropertySetException;
@@ -52,14 +52,14 @@ public class BeanRecordProxy<T> implements Record
{
protected static final Logger log =
LoggerFactory.getLogger(BeanRecordProxy.class);
- protected final Entity entity;
+ protected final EntityType entity;
protected final List<Column> columns;
protected final Column[] keyColumns;
protected T data;
protected boolean[] modified;
- public BeanRecordProxy(T data, List<Column> columns, Column[] keyColumns,
Entity entity)
+ public BeanRecordProxy(T data, List<Column> columns, Column[] keyColumns,
EntityType entity)
{
this.data = data;
this.columns = columns;
@@ -67,7 +67,7 @@ public class BeanRecordProxy<T> implements Record
this.entity = entity;
}
- public BeanRecordProxy(List<Column> columns, Column[] keyColumns, Entity
entity)
+ public BeanRecordProxy(List<Column> columns, Column[] keyColumns,
EntityType entity)
{
this(null, columns, keyColumns, entity);
}
@@ -208,7 +208,7 @@ public class BeanRecordProxy<T> implements Record
}
@Override
- public Entity getEntity()
+ public EntityType getEntityType()
{
return this.entity;
}
@@ -231,7 +231,7 @@ public class BeanRecordProxy<T> implements Record
if (!isValid())
throw new ObjectNotValidException(this);
// getBeanPropertyValue
- return getBeanPropertyValue(data, column);
+ return getBeanProperty(data, column);
}
@Override
@@ -279,7 +279,7 @@ public class BeanRecordProxy<T> implements Record
// validate
value = validateValue(column, value);
// Set Value
- setBeanPropertyValue(data, column, value);
+ setBeanProperty(data, column, value);
return this;
}
@@ -333,7 +333,7 @@ public class BeanRecordProxy<T> implements Record
if (ignoreList != null && ignoreList.contains(column))
continue; // ignore this property
// Get Property Name
- setBeanPropertyValue(bean, column, getValue(i));
+ setBeanProperty(bean, column, getValue(i));
}
return count;
}
@@ -352,7 +352,7 @@ public class BeanRecordProxy<T> implements Record
continue; // ignore this property
// Get Property Name
String property = column.getBeanPropertyName();
- Object value = getBeanPropertyValue(bean, property);
+ Object value = getBeanProperty(bean, property);
set(column, value);
count++;
}
@@ -367,7 +367,7 @@ public class BeanRecordProxy<T> implements Record
// --------------- protected ------------------
- protected Object getBeanPropertyValue(Object bean, ColumnExpr column)
+ protected final Object getBeanProperty(Object bean, ColumnExpr column)
{
// Check Params
if (bean==null)
@@ -375,10 +375,10 @@ public class BeanRecordProxy<T> implements Record
if (column==null)
throw new InvalidArgumentException("column", column);
// getBeanPropertyValue
- return getBeanPropertyValue(bean, column.getBeanPropertyName());
+ return getBeanProperty(bean, column.getBeanPropertyName());
}
- protected Object getBeanPropertyValue(Object bean, String property)
+ protected Object getBeanProperty(Object bean, String property)
{
// Check Params
if (bean==null)
@@ -402,7 +402,7 @@ public class BeanRecordProxy<T> implements Record
}
}
- protected void setBeanPropertyValue(Object bean, Column column, Object
value)
+ protected void setBeanProperty(Object bean, Column column, Object value)
{
// Check Params
if (bean==null)
diff --git
a/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
b/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
index 20c25a2..bf80cad 100644
--- a/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
+++ b/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
@@ -27,7 +27,7 @@ import org.apache.empire.commons.ObjectUtils;
import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.Column;
import org.apache.empire.data.ColumnExpr;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
import org.apache.empire.data.RecordData;
import org.apache.empire.exceptions.InvalidArgumentException;
import org.apache.empire.exceptions.ItemNotFoundException;
@@ -58,7 +58,7 @@ public class DataListEntry implements RecordData, Serializable
return (T)this.head;
}
- public Object[] getRecordKey(Entity entity)
+ public Object[] getRecordKey(EntityType entity)
{
Column[] keyColumns = entity.getKeyColumns();
Object[] key = new Object[keyColumns.length];
@@ -67,11 +67,11 @@ public class DataListEntry implements RecordData,
Serializable
return key;
}
- public long getRecordId(Entity entity)
+ public long getRecordId(EntityType entity)
{
Column[] keyColumns = entity.getKeyColumns();
if (keyColumns.length!=1)
- throw new InvalidArgumentException("entity", entity.getName());
+ throw new InvalidArgumentException("entity",
entity.getEntityName());
// return id
return ObjectUtils.getLong(get(keyColumns[0]));
}
@@ -188,7 +188,7 @@ public class DataListEntry implements RecordData,
Serializable
return ObjectUtils.convert(returnType, get(column));
}
- public final Object[] get(ColumnExpr... columns)
+ public final Object[] getArray(ColumnExpr... columns)
{
Object[] values = new Object[columns.length];
for (int i=0; i<columns.length; i++)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
b/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
index ee610a6..a5ca3d3 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
@@ -34,7 +34,7 @@ import org.apache.empire.commons.Options;
import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.Column;
import org.apache.empire.data.ColumnExpr;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
import org.apache.empire.data.Record;
import org.apache.empire.db.context.DBRollbackHandler;
import org.apache.empire.db.exceptions.FieldReadOnlyException;
@@ -316,7 +316,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
* @return true if this record is a new record
*/
@Override
- public Entity getEntity()
+ public EntityType getEntityType()
{
return getRowSet();
}
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
b/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
index f7cb9ee..346583d 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
@@ -107,9 +107,9 @@ public abstract class DBRecordData extends DBObject
* @Deprecated Renamed to get(...)
*/
@Deprecated
- public final Object[] getValue(ColumnExpr... columns)
+ public final Object[] getValues(ColumnExpr... columns)
{
- return get(columns);
+ return getArray(columns);
}
/**
@@ -144,7 +144,7 @@ public abstract class DBRecordData extends DBObject
* @param column the column expressions
* @return the corresponding record values
*/
- public final Object[] get(ColumnExpr... columns)
+ public final Object[] getArray(ColumnExpr... columns)
{
Object[] values = new Object[columns.length];
for (int i=0; i<columns.length; i++)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
b/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
index 74ca32a..7d9eb7f 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
@@ -33,7 +33,7 @@ import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.Column;
import org.apache.empire.data.ColumnExpr;
import org.apache.empire.data.DataType;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
import org.apache.empire.db.DBRelation.DBCascadeAction;
import org.apache.empire.db.DBRelation.DBReference;
import org.apache.empire.db.exceptions.FieldReadOnlyException;
@@ -70,7 +70,7 @@ import org.slf4j.LoggerFactory;
*
*
*/
-public abstract class DBRowSet extends DBExpr implements Entity
+public abstract class DBRowSet extends DBExpr implements EntityType
{
// *Deprecated* private static final long serialVersionUID = 1L;
@@ -290,7 +290,6 @@ public abstract class DBRowSet extends DBExpr implements
Entity
// ------- Abstract Methods -------
- @Override
public abstract String getName();
public abstract String getAlias();
@@ -314,10 +313,11 @@ public abstract class DBRowSet extends DBExpr implements
Entity
}
/**
- * Returns the entity name for creating qualified names.
+ * Returns the entity name creating qualified names.
* This is usually the same as "getName()" but it may be overridden to
return singular instead of plural
* @return the entity name
*/
+ @Override
public String getEntityName()
{
return StringUtils.coalesce(entityName, getName());
diff --git
a/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordException.java
b/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordException.java
index b9fc2c9..319c005 100644
---
a/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordException.java
+++
b/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordException.java
@@ -21,7 +21,7 @@ package org.apache.empire.db.exceptions;
import org.apache.empire.commons.ErrorType;
import org.apache.empire.commons.ObjectUtils;
import org.apache.empire.commons.StringUtils;
-import org.apache.empire.data.Entity;
+import org.apache.empire.data.EntityType;
import org.apache.empire.data.Record;
import org.apache.empire.db.DBRowSet;
import org.apache.empire.exceptions.EmpireException;
@@ -43,10 +43,10 @@ public abstract class RecordException extends
EmpireException
}
}
- protected static Entity getEntity(Record record)
+ protected static EntityType getEntityType(Record record)
{
try {
- return record.getEntity();
+ return record.getEntityType();
} catch(Exception e) {
return null;
}
@@ -57,9 +57,9 @@ public abstract class RecordException extends EmpireException
return (key==null ? "["+StringUtils.arrayToString(key, "|")+"]" :
"[]");
}
- protected static String entityName(Entity entity)
+ protected static String entityName(EntityType entity)
{
- return (entity!=null ? entity.getName() : "{Null}");
+ return (entity!=null ? entity.getEntityName() : "{Null}");
}
protected static String rowsetName(DBRowSet rowset)
@@ -67,30 +67,30 @@ public abstract class RecordException extends
EmpireException
return (rowset!=null ? StringUtils.coalesce(rowset.getName(),
rowset.getAlias()) : "{Null}");
}
- private transient final Entity entity;
+ private transient final EntityType entityType;
private transient final Object[] key;
- public RecordException(Entity entity, Object[] key, final ErrorType
errType, final String[] params, final Throwable cause)
+ public RecordException(EntityType entityType, Object[] key, final
ErrorType errType, final String[] params, final Throwable cause)
{
super(errType, params, cause);
// save type and params for custom message formatting
- this.entity = entity;
+ this.entityType = entityType;
this.key = key;
}
- public RecordException(Entity entity, Object[] key, final ErrorType
errType, final String[] params)
+ public RecordException(EntityType entity, Object[] key, final ErrorType
errType, final String[] params)
{
this(entity, key, errType, params, null);
}
public RecordException(final Record record, final ErrorType errType, final
String[] params)
{
- this(getEntity(record), getKey(record), errType, params, null);
+ this(getEntityType(record), getKey(record), errType, params, null);
}
- public Entity getRecord()
+ public EntityType getEntityType()
{
- return entity;
+ return entityType;
}
public Object[] getKey()
diff --git
a/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordReadOnlyException.java
b/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordReadOnlyException.java
index 6c27652..eb345f4 100644
---
a/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordReadOnlyException.java
+++
b/empire-db/src/main/java/org/apache/empire/db/exceptions/RecordReadOnlyException.java
@@ -29,6 +29,6 @@ public class RecordReadOnlyException extends RecordException
public RecordReadOnlyException(DBRecordBase record)
{
- super(record, errorType, new String[] { keyToString(getKey(record)),
entityName(getEntity(record)) });
+ super(record, errorType, new String[] { keyToString(getKey(record)),
entityName(getEntityType(record)) });
}
}
