Package com.rosetta.model.lib.meta

Interface Reference

All Superinterfaces:

RosettaModelObject

All Known Subinterfaces:

Reference.ReferenceBuilder

All Known Implementing Classes:

Reference.ReferenceBuilderImpl, Reference.ReferenceImpl

@RosettaDataType(value="Reference",
                 builder=ReferenceBuilderImpl.class)
@RuneDataType(value="Reference",
              builder=ReferenceBuilderImpl.class,
              version="0.0.0")
public interface Reference
extends RosettaModelObject

Author:

TomForwood This class represents a reference to a rosetta object defined elsewhere.

The scope defines where the resolver should look to find the object linked to.

Scope can be - global - the key is universally unique and can be looked up anywhere - e.g. external database - document - the key must be unique in this document and can be found anywhere in the document - the name of the rosetta class e.g. TradeableProduct- the key is only unique inside that TradeableProduct and should only be looked for inside that TradeableProduct

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Reference.ReferenceBuilder
static class	Reference.ReferenceBuilderImpl
static class	Reference.ReferenceImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final RosettaMetaData<Reference>	meta

Method Summary

Modifier and Type	Method	Description
Reference	build()
static Reference.ReferenceBuilderImpl	builder()
String	getPointsTo()
String	getReference()
String	getScope()
default Class<Reference>	getType()
default RosettaMetaData<? extends RosettaModelObject>	metaData()
default void	process(RosettaPath path, Processor processor)
Reference.ReferenceBuilder	toBuilder()

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Field Details

meta

static final RosettaMetaData<Reference> meta

Method Details

build

Reference build()

Specified by:

build in interface RosettaModelObject

toBuilder

Reference.ReferenceBuilder toBuilder()

Specified by:

toBuilder in interface RosettaModelObject

getScope

String getScope()

getPointsTo

String getPointsTo()

getReference

String getReference()

metaData

default RosettaMetaData<? extends RosettaModelObject> metaData()

Specified by:

metaData in interface RosettaModelObject

Returns:

The MetaData RosettaMetaData object for this class providing access to things like validation

builder

static Reference.ReferenceBuilderImpl builder()

getType

default Class<Reference> getType()

Specified by:

getType in interface RosettaModelObject

process

default void process(RosettaPath path,
 Processor processor)

Specified by:

process in interface RosettaModelObject