D-Net

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

	<parent>

		<groupId>eu.dnetlib</groupId>

		<artifactId>dnet-parent</artifactId>

		<version>1.0.0</version>

		<relativePath />

	</parent>

	<modelVersion>4.0.0</modelVersion>

	<groupId>eu.dnetlib</groupId>

	<artifactId>dnet-openaire-data-protos</artifactId>

	<packaging>jar</packaging>

	<version>3.7.6</version>

	<scm>

	  <developerConnection>scm:svn:https://svn.driver.research-infrastructures.eu/driver/dnet40/modules/dnet-openaire-data-protos/tags/dnet-openaire-data-protos-3.7.6</developerConnection>

	</scm>

	<properties>

		<!-- defined also in dnet-parent, here in case we need to override -->

		<google.protobuf.version>2.4.1</google.protobuf.version>

	</properties>

	<pluginRepositories>

		<pluginRepository>

			<id>dnet4-bootstrap-release</id>

			<url>http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-bootstrap-release/</url>

		</pluginRepository>

	</pluginRepositories>

	<build>

		<plugins>

			<plugin>

				<groupId>eu.dnetlib</groupId>

				<artifactId>protoc-jar-maven-plugin</artifactId>

				<version>1.1.0</version>

				<executions>

					<execution>

						<phase>generate-sources</phase>

						<goals>

							<goal>run</goal>

						</goals>

						<configuration>

							<protocVersion>${google.protobuf.version}</protocVersion>

							<inputDirectories>

								<include>src/main/resources</include>

							</inputDirectories>

							<outputDirectory>src/gen/java</outputDirectory>

						</configuration>

					</execution>

				</executions>

			</plugin>

		</plugins>

	</build>

	<dependencies>

		<dependency>

			<groupId>com.google.protobuf</groupId>

			<artifactId>protobuf-java</artifactId>

			<version>${google.protobuf.version}</version>

		</dependency>		

	</dependencies>

</project>

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ResultOrganizationProtos";

message ResultOrganization {

	optional Affiliation affiliation = 1;

	message Affiliation {

		enum RelName {

			isAuthorInstitutionOf = 1; 	// Organization --> Result

			hasAuthorInstitution = 2;	// Result --> Organization

		}

		required RelMetadata relMetadata = 1;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

import "Person.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ResultProtos";

message Result {

	optional Metadata metadata = 2;

	repeated Instance instance = 6;

	repeated ExternalReference externalReference = 7;

	repeated Person author = 8;

	message Metadata {

		// resulttype allows subclassing results into publications or datasets

		optional Qualifier resulttype = 8;

		// common fields

		optional Qualifier language = 12;

		repeated Qualifier country = 33;

		repeated StructuredProperty subject = 1;

		repeated StructuredProperty title = 2;

		repeated StructuredProperty relevantdate = 3;

		repeated StringField description = 25;

		optional StringField dateofacceptance = 4;

		optional StringField publisher = 5;

		optional StringField embargoenddate = 6;

		repeated StringField source = 27;

		repeated StringField fulltext = 29; // remove candidate

		repeated StringField format = 21;

		repeated StringField contributor = 30;

		repeated Context context = 28;

		// publication specific

		optional Journal journal = 18;

		// dataset specific

		optional StringField storagedate = 9;

		optional Qualifier resourcetype = 19;

		optional StringField device = 26;

		optional StringField size = 20;

		optional StringField version = 22;

		optional StringField lastmetadataupdate = 23;

		optional StringField metadataversionnumber = 24;

	}

	message Journal {

		optional string name = 1;

		optional string issnPrinted = 2;

		optional string issnOnline = 3;

		optional string issnLinking = 4;

		optional string ep = 6;

		optional string iss = 7;

		optional string sp = 8;

		optional string vol = 9;

		optional DataInfo dataInfo = 5;

	}

	// <concept id="egi::vo::alice" />

	message Context {

		required string id = 1;

		optional DataInfo dataInfo = 2;

	}

	message Instance {

		optional Qualifier licence = 3;

		optional Qualifier instancetype = 4;

		optional KeyValue hostedby = 5;

		repeated string url = 9;

	}

	message ExternalReference {

		optional string sitename = 1;		// source

		optional string label = 2;			// title

		optional string url = 3;			// text()

		optional string description = 4;	// ?? not mapped yet ??

		optional Qualifier qualifier = 5;	// type

		optional string refidentifier = 6;	// site internal identifier

		optional string query = 7;			// maps the oaf:reference/@query attribute

		optional DataInfo dataInfo = 8;		// ExternalReferences might be also inferred

	}

}

package eu.dnetlib.data.proto;

import "Kind.proto";

import "FieldType.proto";

// for Oafentity

import "Type.proto";

import "Datasource.proto";

import "Organization.proto";

import "Person.proto";

import "Project.proto";

import "Result.proto";

// for OafRel

import "RelType.proto";

import "Datasource_Organization.proto";

import "Person_Result.proto";

import "Project_Organization.proto";

import "Project_Person.proto";

import "Result_Organization.proto";

import "Result_Project.proto";

import "Person_Person.proto";

import "Result_Result.proto";

import "Organization_Organization.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "OafProtos";

message Oaf {

  required Kind kind = 1;

  optional OafEntity entity = 2;

  optional OafRel rel = 3;

  optional DataInfo dataInfo = 4;

	// used to mark the last update time of this object

  optional sfixed64 lastupdatetimestamp = 5;

}

message OafEntity {

  required Type type = 1;

  required string id = 12;

  repeated string originalId = 8;

  repeated KeyValue collectedfrom = 9;

  repeated StructuredProperty pid = 10;

  optional string dateofcollection = 11;

  optional string dateoftransformation = 13;

  /* Any relation that we want to bundle together with this entity.

   It's intended to be used only in temporary values in map/red jobs (sequence files, ...)

   and never persisted values stored in  HBase. */

  repeated OafRel cachedRel = 2;

  repeated Oaf cachedOafRel = 18;

  optional Datasource datasource = 3;

  optional Organization organization = 4;

  optional Person person = 5;

  optional Project project = 6;

  optional Result result = 7;

  repeated OafEntity children = 16;

  repeated ExtraInfo extraInfo = 15;

  optional OAIProvenance oaiprovenance = 17;

}

message OafRel {

  required RelType relType = 1;

  required SubRelType subRelType = 19;

  required string relClass = 20;	// one among the SubRel names, e.g. Provision.RelName.isProvidedBy

  required string source = 2;

  required string target = 3;

  /* if true then is a "child" */

  required bool child = 4;

  optional OafEntity cachedTarget = 5;

  // needed to have more information that is not included in cachedTarget.

  optional Oaf cachedOafTarget = 8;

  // Datamodel rels

  optional DatasourceOrganization datasourceOrganization = 6;

  optional PersonResult personResult = 7;

  optional ProjectOrganization projectOrganization = 9;

  optional ProjectPerson projectPerson = 18;

  optional ResultOrganization resultOrganization = 10;

  optional ResultProject resultProject = 11;

  optional PersonPerson personPerson = 15;

  optional ResultResult resultResult = 16;

  optional OrganizationOrganization organizationOrganization = 17;

  repeated KeyValue collectedfrom = 21;

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "DatasourceOrganizationProtos";

message DatasourceOrganization {

	optional Provision provision = 1;

	message Provision {

		enum RelName {

			isProvidedBy = 1;

			provides = 2;

		}

		required RelMetadata relMetadata = 1;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "RelMetadataProtos";

message RelMetadata {

	optional Qualifier semantics = 1;

	optional string startdate = 3;

	optional string enddate = 4;

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

import "Dedup.proto";

import "DedupSimilarity.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "OrganizationOrganizationProtos";

message OrganizationOrganization {

 	optional Dedup dedup = 1;

  	optional DedupSimilarity dedupSimilarity = 2;

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ProjectOrganizationProtos";

message ProjectOrganization {

	optional Participation participation = 1;

	message Participation {

		enum RelName {

			isParticipant = 1;

			hasParticipant = 2;

		}

		required RelMetadata relMetadata = 1;

		optional string participantnumber = 2;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "DatasourceProtos";

message Datasource {

	optional Metadata metadata = 2;

	message Metadata {

		// common fields

		optional Qualifier datasourcetype = 15;

		optional Qualifier openairecompatibility = 17;

		optional StringField officialname = 1;

		optional StringField englishname = 2;

		optional StringField websiteurl = 3;

		optional StringField logourl = 4;

		optional StringField contactemail = 5;

		optional StringField namespaceprefix = 7;

		optional StringField latitude = 18;

		optional StringField longitude = 19;

		optional StringField dateofvalidation = 20;

		optional StringField description = 21;

		repeated StructuredProperty subjects = 45; 

		// opendoar specific fields (od*)

		optional StringField odnumberofitems = 9;

		optional StringField odnumberofitemsdate = 10;

		optional StringField odpolicies = 12;

		repeated StringField odlanguages = 13;

		repeated StringField odcontenttypes = 14;

		repeated StringField accessinfopackage = 6;

		// re3data fields

		optional StringField releasestartdate = 31; 

		optional StringField releaseenddate = 32;

		optional StringField missionstatementurl = 33;

		optional BoolField dataprovider = 34;

		optional BoolField serviceprovider = 35;

		optional StringField databaseaccesstype = 36; // {open, restricted or closed} 

 		optional StringField datauploadtype = 37; // {open, restricted or closed} 

 		optional StringField databaseaccessrestriction = 38; // {feeRequired, registration, other} 

 		optional StringField datauploadrestriction = 39; // {feeRequired, registration, other} 

 		optional BoolField versioning = 40; 

 		optional StringField citationguidelineurl = 41; 

 		optional StringField qualitymanagementkind = 42; // {yes, no, uknown} 

 		optional StringField pidsystems = 43; 

 		optional StringField certificates = 44;		

		repeated KeyValue policies = 46; 

	}

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ProjectPersonProtos";

message ProjectPerson {

	optional ContactPerson contactPerson = 1;

	message ContactPerson {

		enum RelName {

			isContact = 1;

			hasContact = 2;

		}

		required RelMetadata relMetadata = 1;

	}	

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

import "Dedup.proto";

import "DedupSimilarity.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "PersonPersonProtos";

message PersonPerson {

	optional CoAuthorship coauthorship = 1;

 	optional Dedup dedup = 2;

  	optional DedupSimilarity dedupSimilarity = 3;	

	message CoAuthorship {

		enum RelName {

			isCoauthorOf = 1;

		}

		required RelMetadata relMetadata = 1;

	}

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "DedupProtos";

message Dedup {

	enum RelName {

		isMergedIn = 1;

		merges = 2;

	}

	required RelMetadata relMetadata = 1;

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "PersonResultProtos";

//PersonResult encodes the class of relationships between a Person and a Result

message PersonResult {

	optional Authorship authorship = 1;

	message Authorship {

		enum RelName {

			isAuthorOf = 1;

			hasAuthor = 2;

		}

		required RelMetadata relMetadata = 1;

		optional string ranking = 2;

		optional string affiliation = 3;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "OrganizationProtos";

message Organization {

	optional Metadata metadata = 2;

	message Metadata {

		optional StringField legalshortname = 1;

		optional StringField legalname = 2;

		optional StringField websiteurl = 3;

		optional StringField logourl = 4;

		optional StringField eclegalbody = 5;

		optional StringField eclegalperson = 6;

		optional StringField ecnonprofit = 7;

		optional StringField ecresearchorganization = 8;

		optional StringField echighereducation = 9;

		optional StringField ecinternationalorganizationeurinterests = 10;

		optional StringField ecinternationalorganization = 11;

		optional StringField ecenterprise = 12;

		optional StringField ecsmevalidated = 13;

		optional StringField ecnutscode = 14;

		optional Qualifier country = 16;

	}

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ResultProjectProtos";

message ResultProject {

	optional Outcome outcome = 1;

	message Outcome {

		enum RelName {

			isProducedBy = 1;

			produces = 2;

		}

		required RelMetadata relMetadata = 1;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ProjectProtos";

message Project {

	optional Metadata metadata = 2;

	message Metadata {

		optional StringField websiteurl = 1;

		optional StringField code = 2;

		optional StringField acronym = 3;

		optional StringField title = 4;

		optional StringField startdate = 5;

		optional StringField enddate = 6;

		optional StringField callidentifier = 7;

		optional StringField keywords = 8;

		optional StringField duration = 9;

		optional StringField ecsc39 = 10;

		optional StringField oamandatepublications = 11;

		optional StringField ecarticle29_3 = 12;

		repeated StructuredProperty subjects = 14; 

		repeated StringField fundingtree = 15;

		optional Qualifier contracttype = 13;

		optional StringField optional1 = 16;

		optional StringField optional2 = 17;

		optional StringField jsonextrainfo = 18;

	}

}

package eu.dnetlib.data.proto;

import "FieldType.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "PersonProtos";

message Person {

	optional Metadata metadata = 2;

	message Metadata {

		optional StringField firstname = 1;

		repeated StringField secondnames = 2;

		optional StringField fullname = 11;

		optional StringField fax = 3;

		optional StringField email = 4;

		optional StringField phone = 5;

		optional Qualifier nationality = 9;

	}

	// Dedup preprocess

	repeated CoAuthor coauthor = 4;

	repeated MergedPerson mergedperson = 5;

	optional bool anchor = 6 [default = false];

	message CoAuthor {

		required string id = 1;

		optional string anchorId = 2;

		optional int32 coauthoredpapers = 3 [default = 1];

		optional Metadata metadata = 4;	

	}

	message MergedPerson {

		required string id = 1;

		optional Metadata metadata = 2;	

	}

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "DedupSimilarityProtos";

message DedupSimilarity {

	enum RelName {

		isSimilarTo = 1;

	}

	required RelMetadata relMetadata = 1;

}

package eu.dnetlib.data.proto;

import "RelMetadata.proto";

import "Dedup.proto";

import "DedupSimilarity.proto";

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "ResultResultProtos";

message ResultResult {

	//choice of the possible subtypes

	optional Similarity similarity = 2;

	optional PublicationDataset publicationDataset = 3;

 	optional Dedup dedup = 4;

  	optional DedupSimilarity dedupSimilarity = 5;

  	optional Supplement supplement = 6;

  	optional Part part = 7;

	message Similarity {

		enum RelName {

			isAmongTopNSimilarDocuments = 1;

			hasAmongTopNSimilarDocuments = 2;

		}	

		required RelMetadata relMetadata = 1;

		// level of similarity: coefficient from [0, 1] range,

		// the greater the number, the more similar the documents

    	optional float similarity = 2;

    	enum Type {

			STANDARD = 1;

			WEBUSAGE = 2;

    	}

		// similarity type

    	optional Type type = 3 [default = STANDARD];		

	}

	message PublicationDataset {

		enum RelName {

			isRelatedTo = 1;

		}		

		required RelMetadata relMetadata = 1;

	}

	message Supplement {

        enum RelName {

            isSupplementTo = 1;

            isSupplementedBy = 2;

        }

        required RelMetadata relMetadata = 1;

    }

	message Part {

        enum RelName {

            isPartOf = 1;

            hasPart = 2;

        }

        required RelMetadata relMetadata = 1;

    }

}

package eu.dnetlib.data.proto;

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "RelTypeProtos";

enum RelType {

	// Datamodel rels

	datasourceOrganization = 1;

	personResult = 2;

	projectOrganization = 4;

	projectPerson = 13;

	resultOrganization = 5;

	resultProject = 6;

	resultResult = 9;

	personPerson = 10;

	organizationOrganization = 11;

}

enum SubRelType {

	provision = 1;			// datasourceOrganization

	coauthorship = 2;		// personPerson

	authorship = 3;			// personResult

	participation = 4;		// projectOrganization

	contactPerson = 5;		// projectPerson

	outcome = 6;			// resultProject

	similarity = 8;			// resultResult

	publicationDataset = 9; // resultResult

	affiliation = 12;		// resultOrganizaiton	

	dedup = 10;				// resultResult | personPerson | organizationOrganization

	dedupSimilarity = 11;	// resultResult | personPerson | organizationOrganization

	supplement = 13;        // resultResult

	part = 15;              // resultResult

}

package eu.dnetlib.data.proto;

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "FieldTypeProtos";

message StringField {

 	required string value = 1;

	optional DataInfo dataInfo = 2;

}

message BoolField {

 	required bool value = 1;

	optional DataInfo dataInfo = 2;

}

message IntField {

 	required int32 value = 1;

	optional DataInfo dataInfo = 2;

}

message StructuredProperty {

	required string value = 1;

	optional Qualifier qualifier = 2;

	optional DataInfo dataInfo = 3;

}

// Generic container for identified values, e.g:

//   <oaf:hostedBy name="Publications at Bielefeld University" id="opendoar::2294"/>

//   <oaf:collectedFrom name="Publications at Bielefeld University" id="opendoar::2294"/>

message KeyValue {

	required string key = 1;

	optional string value = 2;

	optional DataInfo dataInfo = 3;

}

message Qualifier {

	optional string classid = 1;

	optional string classname = 2;

	optional string schemeid = 3;

	optional string schemename = 4;

	optional DataInfo dataInfo = 5;

}

message DataInfo {

	optional bool inferred = 1;

	optional bool deletedbyinference = 2;

	optional string trust = 3;

	optional string inferenceprovenance = 4;

	required Qualifier provenanceaction = 5;

}

message OAIProvenance {

	optional OriginDescription originDescription = 1;

	message OriginDescription {

		optional string harvestDate = 1;

		optional bool altered = 2 [default = true];

		optional string baseURL = 3;

		optional string identifier = 4;

		optional string datestamp = 5;

		optional string metadataNamespace = 6;

		optional OriginDescription originDescription = 7;		

	}

}

message ExtraInfo {

	required string name = 1;

	required string typology = 2;

	required string provenance = 3;

	optional string trust = 4;

	// json containing a Citation or Statistics

	optional string value = 5;

}

package eu.dnetlib.data.proto;

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "SpecialTrustProtos";

enum SpecialTrust {

	INFINITE = 1;

	NEUTRAL = 2;

}

package eu.dnetlib.data.proto;

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "TypeProtos";

// entity tags are used as rowkey prefixes on hbase

enum Type {

	datasource = 10;

	organization = 20;

	person = 30;

	project = 40;

	result = 50;

}

package eu.dnetlib.data.proto;

option java_package = "eu.dnetlib.data.proto";

option java_outer_classname = "KindProtos";

enum Kind {

	entity = 1;

	relation = 2;

}

{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/dnet-openaire-data-protos/trunk/", "deploy_repository": "dnet4-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", "name": "dnet-openaire-data-protos"}