Skip to content
This repository has been archived by the owner on Feb 12, 2023. It is now read-only.

Commit

Permalink
Change to correctly compute the isUnitOfRetention value.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mitchellsundt
mitchellsundt committed Aug 27, 2014
1 parent 463cc36 commit 11b382c
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 32 deletions.
7 changes: 6 additions & 1 deletion src/main/java/org/opendatakit/aggregate/odktables/TableManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,12 @@ public TableEntry createTable(String tableId, List<Column> columns)
for (DbColumnDefinitionsEntity e : colDefs) {
e.put(cc);
}

/**
* Update the isUnitOfRetention field for these so they can be used
* to create the data tables on the server.
*/
DbColumnDefinitions.markUnitOfRetention(colDefs);

/**
* Instantiate the actual tables
*/
Expand Down
100 changes: 91 additions & 9 deletions src/main/java/org/opendatakit/aggregate/odktables/relation/DbColumnDefinitions.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@

package org.opendatakit.aggregate.odktables.relation;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.opendatakit.common.ermodel.Entity;
import org.opendatakit.common.ermodel.Query;
Expand All @@ -32,6 +35,10 @@
import org.opendatakit.common.persistence.exception.ODKOverQuotaException;
import org.opendatakit.common.web.CallingContext;

import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
* This defines the columns in a given schemaETag storage representation of that
* tableId. The table defines the abstract objects (e.g., geopoint) and
Expand Down Expand Up @@ -76,9 +83,12 @@ private DbColumnDefinitions(String namespace, String tableName, List<DataField>
dataFields.add(LIST_CHILD_ELEMENT_KEYS);
}

public static final ObjectMapper mapper = new ObjectMapper();

public static class DbColumnDefinitionsEntity {

Entity e;
private boolean isUnitOfRetention = true;

DbColumnDefinitionsEntity(Entity e) {
this.e = e;
Expand Down Expand Up @@ -143,20 +153,38 @@ public String getListChildElementKeys() {
return e.getString(LIST_CHILD_ELEMENT_KEYS);
}

public ArrayList<String> getArrayListChildElementKeys() {
String listChildren = getListChildElementKeys();
if ( listChildren == null || listChildren.length() == 0 ) {
return new ArrayList<String>();
} else {
ArrayList<String> childElementKeys;
try {
childElementKeys = mapper.readValue(listChildren, ArrayList.class);
} catch (JsonParseException e) {
e.printStackTrace();
return new ArrayList<String>();
} catch (JsonMappingException e) {
e.printStackTrace();
return new ArrayList<String>();
} catch (IOException e) {
e.printStackTrace();
return new ArrayList<String>();
}
return childElementKeys;
}
}

public void setListChildElementKeys(String value) {
e.set(LIST_CHILD_ELEMENT_KEYS, value);
}

public boolean isUnitOfRetention() {
String listChild = getListChildElementKeys();
String type = getElementType();
if ( "array".equals(type) ) {
return true;
}
if ( listChild == null || listChild.length() == 0 || "[]".equals(listChild) ) {
return true;
}
return false;
return isUnitOfRetention;
}

private void setNotUnitOfRetention() {
isUnitOfRetention = false;
}

/**
Expand Down Expand Up @@ -233,8 +261,62 @@ public static List<DbColumnDefinitionsEntity> query(String tableId, String schem
for (Entity e : list) {
results.add(new DbColumnDefinitionsEntity(e));
}
markUnitOfRetention(results);
return results;
}

/**
* This code needs to parallel that of the javascript in ODK Survey and the java
* code in ODK Tables and the ODK Database layer.
*
* @param defnList
*/
public static void markUnitOfRetention(List<DbColumnDefinitionsEntity> defnList) {
// for all arrays, mark all descendants of the array as not-retained
// because they are all folded up into the json representation of the array
Map<String, DbColumnDefinitionsEntity> defn = new HashMap<String, DbColumnDefinitionsEntity>();
for ( DbColumnDefinitionsEntity colDefn : defnList ) {
defn.put(colDefn.getElementKey(), colDefn );
}

for (DbColumnDefinitionsEntity colDefn : defnList) {
if (!colDefn.isUnitOfRetention()) {
// this has already been processed
continue;
}
if ("array".equals(colDefn.getElementType())) {
ArrayList<String> childElementKeys = colDefn.getArrayListChildElementKeys();
ArrayList<String> scratchArray = new ArrayList<String>();
while (!childElementKeys.isEmpty()) {
for (String childKey : childElementKeys) {
DbColumnDefinitionsEntity subDefn = defn.get(childKey);
if (!subDefn.isUnitOfRetention()) {
// this has already been processed
continue;
}
subDefn.setNotUnitOfRetention();
if (subDefn.getListChildElementKeys() != null) {
scratchArray.addAll(subDefn.getArrayListChildElementKeys());
}
}
childElementKeys = scratchArray;
}
}
}
// and mark any non-arrays with multiple fields as not retained
for (DbColumnDefinitionsEntity colDefn : defnList) {
if (!colDefn.isUnitOfRetention()) {
// this has already been processed
continue;
}
if (!"array".equals(colDefn.getElementType())) {
if (!colDefn.getArrayListChildElementKeys().isEmpty()) {
colDefn.setNotUnitOfRetention();
}
}
}
}


/**
* Return the actual database column names for the given table.
Expand Down
29 changes: 7 additions & 22 deletions src/main/java/org/opendatakit/aggregate/odktables/rest/entity/Column.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

import java.io.Serializable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
Expand All @@ -45,8 +44,8 @@ public class Column implements Serializable {
*/
/**
* The fully qualified key for this element. If this is a retained field,
* (see isUnitOfRetention, below) then this is the element's database
* column name. For composite types whose elements are individually retained
* then this is the element's database column name. For composite types
* whose elements are individually retained
* (e.g., geopoint), this would be the elementName of the geopoint (e.g.,
* 'myLocation' concatenated with '_' and this elementName (e.g.,
* 'myLocation_latitude').
Expand Down Expand Up @@ -87,8 +86,8 @@ public class Column implements Serializable {
* 'typename' is any other alpha-numeric name (user-definable data type).
*
* The (len) attribute, if present, identifies the VARCHAR storage
* requirements for the field when the field is a unit of retention
* (see isUnitOfRetention below). Ignored if not a unit of retention.
* requirements for the field when the field is a unit of retention.
* Ignored if not a unit of retention.
*
* The server stores:
*
Expand All @@ -108,7 +107,7 @@ public class Column implements Serializable {
*
* array is a JSON serialization expecting one child element key
* that defines the data type in the array. Array fields
* MUST be units of retention (isUnitOfRetention == true).
* MUST be a unit of retention (or be nested within one).
*
* string is a string value
*
Expand Down Expand Up @@ -138,7 +137,7 @@ public class Column implements Serializable {
*/
@JsonProperty(required = false)
private String listChildElementKeys;

/**
* If true, then this elementKey is a column in the backing
* database table. If false, then either the elementKey is a
Expand All @@ -164,7 +163,6 @@ private Column() {
* @param elementName
* @param elementType
* @param listChildElementKeys
* @param isUnitOfRetention
*/
public Column(final String elementKey, final String elementName,
final String elementType, final String listChildElementKeys) {
Expand Down Expand Up @@ -192,20 +190,7 @@ public String getElementType() {
public String getListChildElementKeys() {
return this.listChildElementKeys;
}

@JsonIgnore
public boolean isUnitOfRetention() {
String listChild = getListChildElementKeys();
String type = getElementType();
if ( "array".equals(type) ) {
return true;
}
if ( listChild == null || listChild.length() == 0 || "[]".equals(listChild) ) {
return true;
}
return false;
}


@Override
public String toString() {
return "Column(elementKey=" + this.getElementKey()
Expand Down

0 comments on commit 11b382c

Please sign in to comment.