Package com.rosetta.model.lib.meta

Interface Key

All Superinterfaces:

RosettaModelObject

All Known Subinterfaces:

Key.KeyBuilder

All Known Implementing Classes:

Key.KeyBuilderImpl, Key.KeyImpl

@RosettaDataType(value="Key",
                 builder=KeyBuilderImpl.class)
public interface Key
extends RosettaModelObject

Author:

TomForwood This class represents a value that can be references elsewhere to link to the object the key is associated with The keyValue is required to be unique within the scope defined by "scope" Scope can be - global - the key must be universally unique - document - the key must be unique in this document - the name of the rosetta class e.g. TradeableProduct- the object bearing this key is inside a TradeableProduct and the key is only unique inside that TradeableProduct

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Key.KeyBuilder
static class	Key.KeyBuilderImpl
static class	Key.KeyImpl
static class	Key.KeyMeta

Field Summary

Fields

Modifier and Type	Field	Description
static final Key.KeyMeta	meta

Method Summary

Modifier and Type	Method	Description
Key	build()
static Key.KeyBuilder	builder()
String	getKeyValue()
String	getScope()
default Class<? extends RosettaModelObject>	getType()
default RosettaMetaData<? extends RosettaModelObject>	metaData()
default void	process(RosettaPath path, Processor processor)
Key.KeyBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

meta

static final Key.KeyMeta meta

Method Details

getScope

String getScope()

getKeyValue

String getKeyValue()

build

Key build()

Specified by:

build in interface RosettaModelObject

toBuilder

Key.KeyBuilder toBuilder()

Specified by:

toBuilder in interface RosettaModelObject

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

getType

default Class<? extends RosettaModelObject> getType()

Specified by:

getType in interface RosettaModelObject

process

default void process(RosettaPath path,
 Processor processor)

Specified by:

process in interface RosettaModelObject

builder

static Key.KeyBuilder builder()