package eu.dnetlib.data.proto;

import "eu/dnetlib/data/proto/StructuredProperty.proto";
import "eu/dnetlib/data/proto/Qualifier.proto";
import "eu/dnetlib/data/proto/KeyValue.proto";

import "eu/dnetlib/data/proto/DocumentClasses.proto";
import "eu/dnetlib/data/proto/DocumentClusters.proto";
import "eu/dnetlib/data/proto/DocumentMetrics.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;

	message Metadata {

		// resulttype allows subclassing results into publications or datasets
		optional Qualifier resulttype = 8;

		// common fields
		optional Qualifier language = 12;

		repeated StructuredProperty subject = 1;
		repeated StructuredProperty title = 2;
		repeated StructuredProperty relevantdate = 3;

		repeated string description = 25;
		optional string dateofacceptance = 4;
		optional string publisher = 5;
		optional string embargoenddate = 6;
		optional string storagedate = 9;
		repeated string source = 27;
		repeated string fulltext = 29;
		
		repeated Context context = 28;

		// publication specific
		optional Journal journal = 18;

		// dataset specific
		optional Qualifier resourcetype = 19;
		optional string device = 26;
		optional string size = 20;
		optional string format = 21;
		optional string version = 22;
		optional string lastmetadataupdate = 23;
		optional string metadataversionnumber = 24;
	}
	
	message Journal {
		optional string name = 1;
		optional string issnPrinted = 2;
		optional string issnOnline = 3;
		optional string issnLinking = 4;
	}
	
	// <concept id="egi::vo::alice" />
	message Context {
		required string id = 1;  
	}
	
	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
	}

	// IIS protos
	optional DocumentClasses documentClasses = 3;
	optional DocumentClusters documentClusters = 4;
	optional DocumentMetrics documentMetrics = 5;

}