root
API
Generated with
root/org.eso.ias/org.eso.ias.types/Identifier

Identifier

org.eso.ias.types.Identifier
See theIdentifier companion class
object Identifier

Companion object

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Identifier.type

Members list

Value members

Concrete methods

def apply(fullRunningId: String): Identifier

Factory method to to build a identifier from the passed fullRunningId string.

Factory method to to build a identifier from the passed fullRunningId string.

This method creates all the Identifiers specified in the string and link them in the chain of parents.

Value parameters

fullRunningId

the not null nor empty fullRunningId

Attributes

Returns

a new Identifier

def buildIdFromTemplate(id: String, instance: Option[Int]): String

Build the identifier from a string and a instance number. The instance number, if present, denotes that the identifier is an instance of a template; if the instance is not defined then the identifier is not generated out of a template.

Build the identifier from a string and a instance number. The instance number, if present, denotes that the identifier is an instance of a template; if the instance is not defined then the identifier is not generated out of a template.

Value parameters

id:

the identifier

instance:

the number of the templated instance, if defined

Attributes

Returns

the id for the instance instance of a template

def buildIdFromTemplate(id: String, instance: Int): String

Build the identifier from a string and a instance number.

Build the identifier from a string and a instance number.

Value parameters

id:

the identifier

instance:

the number of the templated instance

Attributes

Returns

the id for the instance instance of a template

def buildTemplatePattern(instance: Int): String

Buildf the pattern with the instance number.

Buildf the pattern with the instance number.

Attributes

def canBeTemplated(idType: IdentifierType): Boolean

Check if the given type supports template

Check if the given type supports template

Attributes

def checkFullRunningIdFormat(frid: String): Boolean

Check if the passed full running id string has the proper format

Check if the passed full running id string has the proper format

Value parameters

frid

The full running id string to check

Attributes

def getBaseId(id: String): String

Get the identifier without the instance.

Get the identifier without the instance.

Attributes

Returns

the identifier without the instance; id if does not contain a template

def getTemplateInstance(id: String): Option[Int]

Get and return the number of the instance of the template from a templated id.

Get and return the number of the instance of the template from a templated id.

Value parameters

id

the identifier

Attributes

Returns

the number of the instance of the template; empty if the identifier does not contain a template

def isTemplatedIdentifier(id: String): Boolean

Check if the passed identifier is generated from a template i.e. if id matches with templatedIdRegExp

Check if the passed identifier is generated from a template i.e. if id matches with templatedIdRegExp

Value parameters

id

the identifier to check

Attributes

def unapply(id: Identifier): String

Extractor

Extractor

Attributes

Concrete fields

val coupleGroupPrefix: String

In the fullRunningID, the id and the type are grouped together to form a couple

In the fullRunningID, the id and the type are grouped together to form a couple

coupleGroupPrefix is the prefix to group them in a string

Attributes

val coupleGroupSuffix: String

In the fullRunningID, the id and the type are grouped together to form a couple

In the fullRunningID, the id and the type are grouped together to form a couple

coupleGroupSuffix is the suffix to group them in a string

Attributes

val coupleSeparator: String

In the fullRunningID, the id and the type are grouped together to form a couple

In the fullRunningID, the id and the type are grouped together to form a couple

coupleSeparator is the separator between them in a string

Attributes

val fullRunningIdRegExp: String

The regular expression of the fullRunning ID

The regular expression of the fullRunning ID

Attributes

val separator: String

The separator between the ID and the parentID of the runningID and the fullRunningID

The separator between the ID and the parentID of the runningID and the fullRunningID

Attributes

val templateRegExp: Regex

The regular expression of a template that matches with strings like [!#4343!]

The regular expression of a template that matches with strings like [!#4343!]

This is used to get the number of an instance

Attributes

val templateSuffix: String

The suffix of an identifier built from a template

The suffix of an identifier built from a template

Attributes

val templatedIdPrefix: String

The prefix of a identifier generated from a template: it is something like ID[!#n!] where n is the n-th instance of the template egnerated from ID

The prefix of a identifier generated from a template: it is something like ID[!#n!] where n is the n-th instance of the template egnerated from ID

Attributes

val templatedIdRegExp: Regex

The regular expression for a identifier generated from a template

The regular expression for a identifier generated from a template

Attributes

Generated with