Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Provenance transforms #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhalexand merged 3 commits into from
Jul 23, 2020
Merged

Provenance transforms #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdde14b
Bumping the version of maven-deploy-plugin to 3.0.0-M1.
Craigacp Jun 23, 2020
5d7114b
Adding methods for transforming provenance objects into more human re…
Craigacp Jul 20, 2020
b132ea5
Fixing the display of map and list provenances in the formattedProven…
Craigacp Jul 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/provenance/Provenance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,18 @@

/**
* A supertype for Provenance objects.
*
* <p>
* One day it will be sealed, currently it is only
* extended by {@link ListProvenance}, {@link MapProvenance},
* {@link ObjectProvenance} and {@link PrimitiveProvenance}.
*
* <p>
* Directly subclassing this will cause the serialisation mechanisms
* for this package to throw ProvenanceException.
*
* <p>
* Provenance implementations must override {@link Object#equals},
* {@link Object#hashCode} and {@link Object#toString} to ensure
* correct operation.
*
* <p>
* Provenance implementations should be immutable.
*/
public interface Provenance extends Serializable { }
192 changes: 180 additions & 12 deletions olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/provenance/ProvenanceUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.LinkedHashMap;
Expand All @@ -84,6 +85,9 @@ public final class ProvenanceUtil {

private static final Logger logger = Logger.getLogger(ProvenanceUtil.class.getName());

/**
* The hash types supported for hashing resources.
*/
public enum HashType {
SHA1("SHA1"), SHA256("SHA-256"), SHA512("SHA-512"), MD5("MD5");

Expand All @@ -92,6 +96,10 @@ public enum HashType {
this.name = name;
}

/**
* Returns a new instance of the appropriate MessageDigest implementation.
* @return The message digest implementation for this hash type.
*/
public MessageDigest getDigest() {
try {
return MessageDigest.getInstance(name);
Expand All @@ -110,9 +118,9 @@ private ProvenanceUtil(){}

/**
* Converts a byte array into a hexadecimal encoded String.
*
* <p>
* Used to convert message digests into Strings.
*
* <p>
* The java.xml.bind.DataTypeConverter class was removed in Java 11, so this is a cross version replacement.
* @param bytes The byte array to convert
* @return A hexadecimal representation of the byte array.
Expand Down Expand Up @@ -292,6 +300,166 @@ public static Optional<OffsetDateTime> getModifiedTime(URL url) {
return Optional.empty();
}

/**
* Formats a provenance object with tabs indenting each child object.
* @param prov Tne provenance to format as a String.
* @return A formatted String view of the provenance.
*/
public static String formattedProvenanceString(ObjectProvenance prov) {
return formattedProvenanceString(prov,0);
}

/**
* Formats a provenance object with tabs indenting the child objects.
* Starts at the supplied depth.
* @param prov The provenance to format.
* @param depth The depth.
* @return A formatted String view of the provenance, tabbed to the right depth.
*/
private static String formattedProvenanceString(ObjectProvenance prov, int depth) {
// Get short class name
String className = prov.getClassName();
String shortClassName = className.substring(className.lastIndexOf(".") + 1);

StringBuilder builder = new StringBuilder();
// Make indent
for (int i = 0; i < depth; i++) {
builder.append('\t');
builder.append('\t');
}
String tabs = builder.toString();
builder.setLength(0);

//builder.append(tabs);
builder.append(shortClassName);
builder.append("(\n");
for (Pair<String,Provenance> p : prov) {
builder.append(tabs);
builder.append('\t');
builder.append(p.getA());
builder.append(" = ");
Provenance innerProv = p.getB();
formatProvenance(innerProv,builder,tabs,depth);
builder.append('\n');
}
builder.append(tabs);
builder.append(')');

return builder.toString();
}

/**
* Formats a single provenance, writing to the supplied builder.
* @param innerProv The provenance to format.
* @param builder The builder to write to.
* @param tabs The current tab String.
* @param depth The current object depth.
*/
private static void formatProvenance(Provenance innerProv, StringBuilder builder, String tabs, int depth) {
if (innerProv instanceof PrimitiveProvenance) {
builder.append(((PrimitiveProvenance<?>)innerProv).getValue().toString());
} else if (innerProv instanceof ListProvenance) {
ListProvenance<?> listProv = (ListProvenance<?>) innerProv;
if (listProv.getList().isEmpty()) {
builder.append("List[]");
} else {
builder.append("List[\n");
for (Provenance provElem : listProv) {
builder.append(tabs);
builder.append("\t\t");
formatProvenance(provElem,builder,tabs,depth+1);
builder.append('\n');
}
builder.append(tabs);
builder.append("\t]");
}
} else if (innerProv instanceof MapProvenance) {
MapProvenance<?> mapProv = (MapProvenance<?>) innerProv;
if (mapProv.getMap().isEmpty()) {
builder.append("Map{}");
} else {
builder.append("Map{\n");
for (Pair<String,? extends Provenance> provElem : mapProv) {
builder.append(tabs);
builder.append("\t\t");
builder.append(provElem.getA());
builder.append('=');
formatProvenance(provElem.getB(),builder,tabs,depth+1);
builder.append('\n');
}
builder.append(tabs);
builder.append("\t}");
}
} else if (innerProv instanceof ObjectProvenance) {
String innerProvString = formattedProvenanceString((ObjectProvenance)innerProv,depth+1);
builder.append(innerProvString);
} else {
throw new IllegalStateException("Unrecognised provenance base type " + innerProv.getClass());
}
}

/**
* The values in this map are either String, List or Map.
* The maps are the same type as the output map, and the Lists contain
* either Strings, Lists or Maps.
* <p>
* It's a weakly typed version of the provenance structures.
* @param prov The provenance to convert.
* @return A (possibly nested) map representing the provenance.
*/
public static Map<String, Object> convertToMap(ObjectProvenance prov) {
Map<String,Object> output = new HashMap<>();

for (Pair<String,Provenance> p : prov) {
String key = p.getA();
Provenance innerProv = p.getB();
Object value = innerConvertToMap(innerProv);
output.put(key,value);
}

return Collections.unmodifiableMap(output);
}

/**
* Converts a provenance into an immutable set of Strings, Lists and Maps.
* The object graph only contains those three types.
* @param prov The provenance to convert.
* @return A structure suitable for display or conversion into JSON.
*/
private static Object innerConvertToMap(Provenance prov) {
if (prov instanceof PrimitiveProvenance) {
return ((PrimitiveProvenance<?>)prov).getValue().toString();
} else if (prov instanceof ListProvenance) {
ListProvenance<?> listProv = (ListProvenance<?>) prov;
if (listProv.getList().isEmpty()) {
return Collections.emptyList();
} else {
List<Object> list = new ArrayList<>();
for (Provenance provElem : listProv) {
list.add(innerConvertToMap(provElem));
}
return Collections.unmodifiableList(list);
}
} else if (prov instanceof MapProvenance) {
MapProvenance<?> mapProv = (MapProvenance<?>) prov;
if (mapProv.getMap().isEmpty()) {
return Collections.emptyMap();
} else {
Map<String,Object> map = new HashMap<>();
for (Pair<String,? extends Provenance> provElem : mapProv) {
String newKey = provElem.getA();
Object newValue = innerConvertToMap(provElem.getB());
map.put(newKey,newValue);
}
return Collections.unmodifiableMap(map);
}
} else if (prov instanceof ObjectProvenance) {
return convertToMap((ObjectProvenance)prov);
} else {
throw new IllegalStateException("Unrecognised provenance base type " + prov.getClass());
}
}

/**
* Extracts a list of ConfigurationData which can be used to reconstruct the objects
* recorded in this provenance.
Expand Down Expand Up @@ -402,7 +570,7 @@ public static String computeName(ObjectProvenance obj, int number) {

/**
* Marshals the provenance into a list of flattened objects.
*
* <p>
* Similar to the configuration extraction, but preserves all the information.
* @param provenance The provenance to marshal.
* @return A list of marshalled objects.
Expand Down Expand Up @@ -522,7 +690,7 @@ private static void extractProvenanceToQueue(Queue<ObjectProvenance> processingQ
/**
* Assumes a closed world (so the names in the {@link MarshalledProvenance} objects don't collide).
* The first element of the list must be the root of the DAG, and it must only have a single root.
*
* <p>
* This method throws {@link ProvenanceException} when the <code>marshalledProvenance</code> list
* contains malformed objects, the classes are missing, or the appropriate constructors are not available.
* @param marshalledProvenance The marshalled provenances to unmarshall.
Expand Down Expand Up @@ -583,7 +751,7 @@ private static ObjectProvenance unmarshalProvenance(ObjectMarshalledProvenance c
* Converts a FlatMarshalledProvenance into a Provenance, either by recursively calling {@link ProvenanceUtil#unmarshalFlat} on
* the elements of a list or map, by recursively calling {@link ProvenanceUtil#unmarshalProvenance} on an ObjectMarshalledProvenance
* or calling {@link SimpleMarshalledProvenance#unmarshallPrimitive()} on a primitive.
*
* <p>
* Throws provenance exception if there is a cycle or an unexpected class was found.
* @param hostProvName The host provenance name, used for error messages.
* @param fmp The marshalled provenance to unmarshal.
Expand Down Expand Up @@ -643,9 +811,9 @@ private static Provenance unmarshalFlat(String hostProvName, FlatMarshalledProve
* advised to <b>avoid using this method</b> but if you do use it, then you
* should extensively unit test code that depends on this method.
*
* @param provenancable
* @param outputStream
* @throws IOException
* @param provenancable The provenancable object to serialize.
* @param outputStream The output stream to write to.
* @throws IOException If the stream couldn't be written to.
*/
public static void writeObject(Provenancable<? extends ConfiguredObjectProvenance> provenancable, ObjectOutputStream outputStream) throws IOException {
ObjectProvenance provenance = provenancable.getProvenance();
Expand All @@ -658,10 +826,10 @@ public static void writeObject(Provenancable<? extends ConfiguredObjectProvenanc
* {@link #writeObject(Provenancable, ObjectOutputStream)} for why you should
* take extra care when deliberating whether or not to use this method.
*
* @param inputStream
* @return
* @throws ClassNotFoundException
* @throws IOException
* @param inputStream The stream to read from.
* @return The object reconstructed from it's provenance.
* @throws ClassNotFoundException If the class isn't available.
* @throws IOException If the stream couldn't be read.
*/
public static Provenancable<? extends ConfiguredObjectProvenance> readObject(ObjectInputStream inputStream) throws ClassNotFoundException, IOException {
ConfiguredObjectProvenance provenance = (ConfiguredObjectProvenance) inputStream.readObject();
Expand Down
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,11 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.0.0-M1</version>
</plugin>
</plugins>
</build>
</project>