org.wikimedia.eventutilities.core.event

Class EventLoggingSchemaLoader

java.lang.Object

org.wikimedia.eventutilities.core.event.EventSchemaLoader

org.wikimedia.eventutilities.core.event.EventLoggingSchemaLoader

public class EventLoggingSchemaLoader
extends EventSchemaLoader

Loads EventLogging schemas from schema names (and/or revisions) by extending EventSchemaLoader and adding Mediawiki extension EventLogging schema specific functionality. When looking up schemas for event instances, this will always use the latest schema. Usage:

 EventLoggingSchemaLoader schemaLoader = new EventLoggingSchemaLoader();

 // Load Test schema revision 123
 schemaLoader.getEventSchema("Test", 123);

 // Load the schema for JsonNode or Json String event (schema name is at /schema in event).
 schemaLoader.getEventSchema(event);
 

Nested Class Summary

Nested classes/interfaces inherited from class org.wikimedia.eventutilities.core.event.EventSchemaLoader

EventSchemaLoader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EVENTLOGGING_SCHEMA_FIELD EventLogging schema names are in an event's `schema` field.
protected com.fasterxml.jackson.databind.JsonNode	eventLoggingCapsuleSchema EventCapsule schema.

Fields inherited from class org.wikimedia.eventutilities.core.event.EventSchemaLoader

LATEST_FILE_NAME, schemaFieldPointer, schemaLoader

Constructor Summary

Constructors

Constructor and Description
EventLoggingSchemaLoader(JsonSchemaLoader schemaLoader) Returns an EventLoggingSchemaLoader that uses JsonSchemaLoader to load JSONSchemas.

Method Summary

Modifier and Type	Method and Description
protected static com.fasterxml.jackson.databind.JsonNode	buildEventLoggingCapsule() Adapted from https://github.com/wikimedia/eventlogging/blob/master/eventlogging/capsule.py.
protected com.fasterxml.jackson.databind.JsonNode	encapsulateEventLoggingSchema(com.fasterxml.jackson.databind.JsonNode schema) Given an EventLogging schema in an ObjectNode, 'encapsulate' it in the eventLoggingCapsuleSchema the same way that EventLogging python would.
protected URI	eventLoggingSchemaUriFor(String name) Builds an EventLogging Mediawiki API schema URI for the latest revision.
protected URI	eventLoggingSchemaUriFor(String name, Integer revision) Builds an EventLogging Mediawiki API schema URI for a specific schema revision.
com.fasterxml.jackson.databind.JsonNode	getEventLoggingSchema(String schemaName) Given an EventLogging schema name , this will get the latest schema revision from EVENTLOGGING_SCHEMA_BASE_URI and encapsulate it.
com.fasterxml.jackson.databind.JsonNode	getEventLoggingSchema(String schemaName, Integer revision) Given an EventLogging event schema name and revision, this will get the schema from EVENTLOGGING_SCHEMA_BASE_URI and encapsulate it.
com.fasterxml.jackson.databind.JsonNode	getEventSchema(com.fasterxml.jackson.databind.JsonNode event) Given an EventLogging event object, this extracts its schema name at /schema and uses it to get the latest EventLogging schema.
com.fasterxml.jackson.databind.JsonNode	getEventSchema(String eventString) Given an EventLogging json event string, this parses it to a JsonNode and then extracts its schema name at /schema and uses it to get the latest EventLogging schema.
URI	getEventSchemaUri(com.fasterxml.jackson.databind.JsonNode event) Returns the latest EventLogging schema URI for this event.
com.fasterxml.jackson.databind.JsonNode	getLatestEventSchema(com.fasterxml.jackson.databind.JsonNode event) Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and resolves it to the latest schema URI and returns the schema there.
com.fasterxml.jackson.databind.JsonNode	getLatestEventSchema(String eventString) Given a JSON event string, get its schema URI, and load and return latest schema for the event.
com.fasterxml.jackson.databind.JsonNode	load(URI schemaUri) Given a URI to an EventLogging 'event' field (un-encapsulated) schema, this will get the 'event' field schema at that URI, and then encapsulate it.
String	toString()

Methods inherited from class org.wikimedia.eventutilities.core.event.EventSchemaLoader

builder, extractSchemaUri, getEventJsonSchema, getEventJsonSchema, getJsonLoader, getJsonSchema, getLatestSchema, getLatestSchemaUri, getLatestSchemaUri, getLatestVersionFileName, getResourceLoader, getSchema, latestSchemaURI, schemaUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENTLOGGING_SCHEMA_FIELD

protected static final String EVENTLOGGING_SCHEMA_FIELD

EventLogging schema names are in an event's `schema` field.

See Also:

Constant Field Values

eventLoggingCapsuleSchema

protected final com.fasterxml.jackson.databind.JsonNode eventLoggingCapsuleSchema

EventCapsule schema.

Constructor Detail

EventLoggingSchemaLoader

public EventLoggingSchemaLoader(JsonSchemaLoader schemaLoader)

Returns an EventLoggingSchemaLoader that uses JsonSchemaLoader to load JSONSchemas.

Parameters:

schemaLoader - must have an underlying ResourceLoader that knows how to load relative schema URIs, which in EventLogging's case are MediaWiki action API params.

Method Detail

buildEventLoggingCapsule

protected static com.fasterxml.jackson.databind.JsonNode buildEventLoggingCapsule()

Adapted from https://github.com/wikimedia/eventlogging/blob/master/eventlogging/capsule.py.

load

public com.fasterxml.jackson.databind.JsonNode load(URI schemaUri)
                                             throws JsonLoadingException

Given a URI to an EventLogging 'event' field (un-encapsulated) schema, this will get the 'event' field schema at that URI, and then encapsulate it. This will use the schemaLoader's schema cache to cache the encapsulated schema by an artificial encapsulated schema URI value.

Overrides:

load in class EventSchemaLoader

Returns:

the jsonschema at schemaURI.

Throws:

JsonLoadingException

getEventSchemaUri

public URI getEventSchemaUri(com.fasterxml.jackson.databind.JsonNode event)

Returns the latest EventLogging schema URI for this event.

Parameters:

event - should have field at schemaFieldPointer pointing at its URI.

getEventSchema

public com.fasterxml.jackson.databind.JsonNode getEventSchema(com.fasterxml.jackson.databind.JsonNode event)
                                                       throws JsonLoadingException

Given an EventLogging event object, this extracts its schema name at /schema and uses it to get the latest EventLogging schema.

Overrides:

getEventSchema in class EventSchemaLoader

Throws:

JsonLoadingException

getEventSchema

public com.fasterxml.jackson.databind.JsonNode getEventSchema(String eventString)
                                                       throws JsonLoadingException

Given an EventLogging json event string, this parses it to a JsonNode and then extracts its schema name at /schema and uses it to get the latest EventLogging schema.

Overrides:

getEventSchema in class EventSchemaLoader

Throws:

JsonLoadingException

getLatestEventSchema

public com.fasterxml.jackson.databind.JsonNode getLatestEventSchema(com.fasterxml.jackson.databind.JsonNode event)
                                                             throws JsonLoadingException

Description copied from class: EventSchemaLoader

Given an event object, this extracts its schema URI at schemaField (prefixed with baseURI) and resolves it to the latest schema URI and returns the schema there.

Overrides:

getLatestEventSchema in class EventSchemaLoader

Throws:

JsonLoadingException

getLatestEventSchema

public com.fasterxml.jackson.databind.JsonNode getLatestEventSchema(String eventString)
                                                             throws JsonLoadingException

Description copied from class: EventSchemaLoader

Given a JSON event string, get its schema URI, and load and return latest schema for the event.

Overrides:

getLatestEventSchema in class EventSchemaLoader

Throws:

JsonLoadingException

getEventLoggingSchema

public com.fasterxml.jackson.databind.JsonNode getEventLoggingSchema(String schemaName)
                                                              throws JsonLoadingException

Given an EventLogging schema name , this will get the latest schema revision from EVENTLOGGING_SCHEMA_BASE_URI and encapsulate it.

Throws:

JsonLoadingException

getEventLoggingSchema

public com.fasterxml.jackson.databind.JsonNode getEventLoggingSchema(String schemaName,
                                                                     Integer revision)
                                                              throws JsonLoadingException

Given an EventLogging event schema name and revision, this will get the schema from EVENTLOGGING_SCHEMA_BASE_URI and encapsulate it.

Returns:

event schema

Throws:

JsonLoadingException

eventLoggingSchemaUriFor

protected URI eventLoggingSchemaUriFor(String name)

Builds an EventLogging Mediawiki API schema URI for the latest revision.

Parameters:

name - schema name

Returns:

EventLogging schema URI

eventLoggingSchemaUriFor

protected URI eventLoggingSchemaUriFor(String name,
                                       Integer revision)

Builds an EventLogging Mediawiki API schema URI for a specific schema revision.

Parameters:

name - schema name

revision - schema revision

Returns:

EventLogging schema URI

encapsulateEventLoggingSchema

protected com.fasterxml.jackson.databind.JsonNode encapsulateEventLoggingSchema(com.fasterxml.jackson.databind.JsonNode schema)

Given an EventLogging schema in an ObjectNode, 'encapsulate' it in the eventLoggingCapsuleSchema the same way that EventLogging python would.

Parameters:

schema - the event schema to be encapsulated. Its 'properties' will be set as 'event'.

Returns:

encapsulated EventLogging schema

toString

public String toString()

Overrides:

toString in class EventSchemaLoader