Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eparejatobes committed Sep 27, 2016
1 parent 904aed1 commit 587ec96
Show file tree
Hide file tree
Showing 9 changed files with 625 additions and 35 deletions.
4 changes: 3 additions & 1 deletion docs/src/main/java/com/bio4j/model/ENZYMEGraph.java.md
Expand Up @@ -149,7 +149,9 @@ _TO DO_ explain this. Shuold this be a crossref?
[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md
4 changes: 3 additions & 1 deletion docs/src/main/java/com/bio4j/model/GOGraph.java.md
Expand Up @@ -214,7 +214,9 @@ See [GO Ontology Relations](http://www.geneontology.org/GO.ontology.relations.sh
[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md
154 changes: 154 additions & 0 deletions docs/src/main/java/com/bio4j/model/LinkGraph.java.md
@@ -0,0 +1,154 @@

```java
package com.bio4j.model;

import com.bio4j.angulillos.*;
import java.util.Set;

// TODO move to angulillos
public abstract class LinkGraph<
G extends LinkGraph<G,RV,RE>,
RV,RE
>
extends TypedGraph<G,RV,RE> {

protected LinkGraph(UntypedGraph<RV,RE> raw) { super(raw); }

// TODO these two classes are duplicated here because of them being private in angulillos
private abstract class FunnyElement<
F extends FunnyElement<F,FT, RF>,
FT extends FunnyElementType<F,FT, RF>,
RF
> implements TypedElement<F,FT, G,RF> {

private final RF raw;
private final FT type;

@Override public final RF raw() { return this.raw; }
@Override public final FT type() { return this.type; }

// NOTE: we cannot do the same to `self`, because `super()` constructor cannot refer to `this`
protected FunnyElement(RF raw, FT type) {
this.raw = raw;
this.type = type;
}
}

private abstract class FunnyElementType<
F extends FunnyElement<F,FT, RF>,
FT extends FunnyElementType<F,FT, RF>,
RF
> implements TypedElement.Type<F,FT, G,RF> {

@Override public final G graph() { return LinkGraph.this.self(); }

public abstract F fromRaw(RF raw);

protected abstract FT self();
```

This set stores all properties that are defined on this element type

```java
private final Set<AnyProperty> properties = new java.util.HashSet<>();
public final Set<AnyProperty> properties() { return this.properties; }


// public abstract class Property<X>
// implements com.bio4j.angulillos.Property<FT,X> {
// // NOTE: this initializer block will be inherited and will add each vertex type to the set
// {
// if (
// ElementType.this.properties.removeIf( (AnyProperty p) ->
// p._label().equals( this._label() )
// )
// ) {
// throw new IllegalArgumentException(
// "Element type [" +
// ElementType.this._label() +
// "] contains duplicate property: " +
// this._label()
// );
// }
// ElementType.this.properties.add(this);
// }
//
// private final Class<X> valueClass;
//
// @Override public final FT elementType() { return self(); }
// @Override public final Class<X> valueClass() { return this.valueClass; }
//
// protected Property(Class<X> valueClass) {
// this.valueClass = valueClass;
// }
// }
}


public abstract class LinkEdge<
SG extends TypedGraph<SG,RV,RE>,
S extends TypedGraph<SG,RV,RE>.Vertex<S>,
E extends LinkEdge<SG,S,E,TG,T>,
TG extends TypedGraph<TG,RV,RE>,
T extends TypedGraph<TG,RV,RE>.Vertex<T>
> extends FunnyElement<E,LinkEdgeType<SG,S,E,TG,T>,RE>
implements TypedEdge<
S, TypedGraph<SG,RV,RE>.VertexType<S>,
E, LinkEdgeType<SG,S,E,TG,T>,
T, TypedGraph<TG,RV,RE>.VertexType<T>,
G,RV,RE
>
{
protected LinkEdge(RE raw, LinkEdgeType<SG,S,E,TG,T> type) { super(raw, type); }
}

// TODO initializer block missing
public abstract class LinkEdgeType<
SG extends TypedGraph<SG,RV,RE>,
S extends TypedGraph<SG,RV,RE>.Vertex<S>,
E extends LinkEdge<SG,S,E,TG,T>,
TG extends TypedGraph<TG,RV,RE>,
T extends TypedGraph<TG,RV,RE>.Vertex<T>
> extends FunnyElementType<E, LinkEdgeType<SG,S,E,TG,T>, RE>
implements TypedEdge.Type<
S, TypedGraph<SG,RV,RE>.VertexType<S>,
E, LinkEdgeType<SG,S,E,TG,T>,
T, TypedGraph<TG,RV,RE>.VertexType<T>,
G,RV,RE
>
{

protected LinkEdgeType<SG,S,E,TG,T> self() { return this; }

private final TypedGraph<SG,RV,RE>.VertexType<S> sourceType;
private final TypedGraph<TG,RV,RE>.VertexType<T> targetType;

@Override public final TypedGraph<SG,RV,RE>.VertexType<S> sourceType() { return this.sourceType; }
@Override public final TypedGraph<TG,RV,RE>.VertexType<T> targetType() { return this.targetType; }

protected LinkEdgeType(TypedGraph<SG,RV,RE>.VertexType<S> sourceType, TypedGraph<TG,RV,RE>.VertexType<T> targetType) {

this.sourceType = sourceType;
this.targetType = targetType;

// private access in angulillos
// sourceType.outEdges.add( self() );
// targetType.inEdges.add( self() );
}
}
}

```




[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md
4 changes: 3 additions & 1 deletion docs/src/main/java/com/bio4j/model/NCBITaxonomyGraph.java.md
Expand Up @@ -140,7 +140,9 @@ Every taxon *but* the root has *exactly one* parent.
[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md
Expand Up @@ -35,7 +35,9 @@ public final class UniProtENZYMEGraph<V,E> extends TypedGraph<UniProtENZYMEGraph
[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md
4 changes: 3 additions & 1 deletion docs/src/main/java/com/bio4j/model/UniProtGOGraph.java.md
Expand Up @@ -30,7 +30,9 @@ public final class UniProtGOGraph<V,E> extends TypedGraph<UniProtGOGraph<V,E>,V,
[main/java/com/bio4j/model/UniProtGraph.java]: UniProtGraph.java.md
[main/java/com/bio4j/model/UniProtENZYMEGraph.java]: UniProtENZYMEGraph.java.md
[main/java/com/bio4j/model/NCBITaxonomyGraph.java]: NCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/UniRefGraph.java]: UniRefGraph.java.md
[main/java/com/bio4j/model/ENZYMEGraph.java]: ENZYMEGraph.java.md
[main/java/com/bio4j/model/UniProtNCBITaxonomyGraph.java]: UniProtNCBITaxonomyGraph.java.md
[main/java/com/bio4j/model/GOGraph.java]: GOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/UniProtGOGraph.java]: UniProtGOGraph.java.md
[main/java/com/bio4j/model/LinkGraph.java]: LinkGraph.java.md

0 comments on commit 587ec96

Please sign in to comment.