Uses of Interface
com.genologics.ri.Locatable
Package
Description
The root package of the classes generated (originally) from the
Clarity schemas.
The main public package of the Clarity API.
Package supporting caching of Clarity entities in memory
(or, if so configured, on disk) to reduce the amount of traffic being
sent to and from the REST API.
Concrete implementation classes of the Clarity API.
-
Uses of Locatable in com.genologics.ri
Modifier and TypeInterfaceDescriptioninterface
Interface for classes that are links to real LIMS objects.interface
Marker interface that indicates a locatable object can be linked to.Modifier and TypeInterfaceDescriptioninterface
LimsEntity<E extends LimsEntity<E>>
Interface for all objects that are real LIMS entities (i.e. not links or other references).interface
LimsEntityLink<E extends LimsEntity<E>>
Interface for links to LimsEntity objects.interface
LimsEntityLinkable<E extends LimsEntity<E>>
Interface for entities and links to entities that are identifiable in the system (i.e. have a LIMS id).interface
Interface for classes that are links to real LIMS objects.interface
Marker interface that indicates a locatable object can be linked to.Modifier and TypeClassDescriptionclass
Container is a child element of location and provides a URI linking to the detailed representation of the Container for the location.class
An external id is a reference to an identifier in an external system that contains additional information about a representation within the API.class
A link provides a URI linking to an additional resource.class
Location provides a URI linking to the detailed representation of a Container along with the well location within that Container.class
The link to a page of additional content.Modifier and TypeMethodDescriptionstatic String
Link.limsIdFromUri
(Locatable thing) Extract the LIMS identifier from the URI of a Locatable object. -
Uses of Locatable in com.genologics.ri.artifact
Modifier and TypeClassDescriptionclass
The detailed representation of an Artifact.class
Artifact group is a child element of Artifact and provides a URI linking to the detailed representation of the artifact group that the Artifact belongs to.class
Artifact-link is a child element type of artifacts and provides a URI linking to the detailed representation of an artifact.class
Provide a URI linking to the control type if this artifact is a control sample.class
The detailed representation of the demultiplexing of a pooled artifact.class
Details of an individual artifact that is part of a pooled artifact.class
The details of a sample that is part of a pooled artifact.class
Identifies the resource that will demultiplex this artifact.class
class
Parent-process is a child element of Artifact and provides a URI linking to the detailed representation of the process that produced the Artifact.class
The details of the pooling step that created the pooled sample(s).class
Sample is a child element of Artifact and provides a URI linking to the detailed representation of a submitted Sample for the Artifact.class
Provides links to workflow stages, stage names and their respective statuses. -
Uses of Locatable in com.genologics.ri.artifactgroup
Modifier and TypeClassDescriptionclass
ArtifactGroups are created by the Lab Scientist interface for each workflow.class
artifactGroup-link is a child element type of artifactGroup and provides a URI linking to the detailed representation of a artifactGroup.class
Artifacts is a link to 1...n child artifacts, that belong to the artifactGroup The link to an artifactList, filtered on artifactgroupID -
Uses of Locatable in com.genologics.ri.automation
Modifier and TypeClassDescriptionclass
The automation element integrates the process with the Automation Worker (previously called External Program Plugin or EPP).class
class
Provides links to process types the automation is enabled on. -
Uses of Locatable in com.genologics.ri.configuration
Modifier and TypeClassDescriptionclass
The detailed representation of the configuration of a user-defined field.class
Field definition represents a user-defined field configured in the parent entity.class
The detailed representation of the configuration of a user defined type.class
Type-definition provides a URI linking to the user defined type associated with the user-defined field, if applicable.class
Udfconfig-link is a child element type of udfs and provides a URI linking to the detailed representation of the configuration for a user defined field.class
Udtconfig-link is a child element type of udts and provides a URI linking to the detailed representation of the configuration for a user defined type. -
Uses of Locatable in com.genologics.ri.container
Modifier and TypeClassDescriptionclass
class
Container-link is a child element type of containers and provides a URI linking to the detailed representation of a container.class
Container-type is a child element of container and provides a URI linking to the detailed representation of the container type that the container is associated with.class
Placement is a child element of container and provides a URI linking to the detailed representation of the artifact that is located in a specific well of the container. -
Uses of Locatable in com.genologics.ri.containertype
Modifier and TypeClassDescriptionclass
The detailed representation of a container type.class
Container-type-link is a child element type of containers and provides a URI linking to the detailed representation of a container type. -
Uses of Locatable in com.genologics.ri.controltype
Modifier and TypeClassDescriptionclass
class
Control-type-link is a child element type of controlTypes and provides a URI linking to the detailed representation of a ControlType. -
Uses of Locatable in com.genologics.ri.file
Modifier and TypeClassDescriptionclass
The file element contains information about a file in the system.class
The file-link type provides a URI that links to information about a file in the system. -
Uses of Locatable in com.genologics.ri.instrument
Modifier and TypeClassDescriptionclass
The detailed representation of an instrument.class
Instrument-link is a child element type of instruments and provides a URI linking to the detailed representation of an instrument. -
Uses of Locatable in com.genologics.ri.instrumenttype
Modifier and TypeClassDescriptionclass
An instrument describes properties common to all instruments of that type.class
class
-
Uses of Locatable in com.genologics.ri.lab
-
Uses of Locatable in com.genologics.ri.permission
-
Uses of Locatable in com.genologics.ri.process
Modifier and TypeClassDescriptionclass
Artifact is a child element of input-output-map and provides a link to an Artifact that was either an input or output of the Process for the input-output-map.class
The detailed representation of a process.class
The instrument element provides a URI to the instrument that is responsible for running the process.class
Parent-process is a child element of Artifact and provides a URI linking to the Process that created the Artifact.class
Process-link is a child element type of process and provides a URI linking to the detailed representation of a process.class
Process-type is a child element of process that identifies and provides a URI linking to the detailed representation of the process type that the process is associated with.class
Technician is a child element of Process and provides a URI linking to the detailed representation of the technician that ran the Process. -
Uses of Locatable in com.genologics.ri.processexecution
Modifier and TypeClassDescriptionclass
The input element provides URIs to one or more Artifacts that will be used by the Process.class
The instrument element provides a URI to the instrument that is responsible for running the process.class
The technician element provides a URI to the user that is responsible for the Process. -
Uses of Locatable in com.genologics.ri.processtemplate
Modifier and TypeClassDescriptionclass
The instrument is a child element of process-template that provides a URI to the instrument that is responsible for running a Process created using this Process Template.class
The detailed representation of a Process Template.class
process-template-link is a child element type of Process Templates and provides a URI linking to the detailed representation of a Process Template.class
Process-type is a child element of process-template that identifies and provides a URI linking to the detailed representation of the Process Type that the Process Template is associated with.class
Technician is a child element of process-template and provides a URI linking to the detailed representation of the technician that is configured to run a Process created using this Process Template. -
Uses of Locatable in com.genologics.ri.processtype
Modifier and TypeClassDescriptionclass
class
class
The process-type element contains the XML representation of a type of process configured in the system.class
Process-type-link is a child element type of process types and provides a URI linking to the detailed representation of a process type.class
Reagent-kit-link is a child element type of reagentKits and provides a URI linking to the detailed representation of a ReagentKit.class
Type-definition is a child element of process type providing a URI linking to the configuration of a user-defined type for the process type. -
Uses of Locatable in com.genologics.ri.project
Modifier and TypeClassDescriptionclass
The detailed representation of a Project.class
Project-link is a child element type of projects and provides a URI linking to the detailed representation of a project.class
Researcher is a child element of Project and provides a URI linking to the detailed representation of the Researcher for the Project. -
Uses of Locatable in com.genologics.ri.protocolconfiguration
Modifier and TypeClassDescriptionclass
Detailed representation of a protocol.class
-
Uses of Locatable in com.genologics.ri.queue
-
Uses of Locatable in com.genologics.ri.reagentkit
Modifier and TypeClassDescriptionclass
The detailed representation of a reagent kit.class
Reagent-Kit-Link is a child element type of reagent kits and provides a URI linking to the detailed representation of a reagent kit. -
Uses of Locatable in com.genologics.ri.reagentlot
Modifier and TypeClassDescriptionclass
Reagent-Kit-Link is an element providing a URI linking to the detailed representation of a reagent kit.class
The detailed representation of a Reagent Lotclass
Reagent-lot-link is a child element type of Reagent Lots and provides a URI linking to the detailed representation of a Reagent Lot.class
Researcher is a child element of the reagent lot. -
Uses of Locatable in com.genologics.ri.reagenttype
Modifier and TypeClassDescriptionclass
The detailed representation of a reagent type.class
Reagent-type-link is a child element type of reagent types and provides a URI linking to the detailed representation of a reagent type. -
Uses of Locatable in com.genologics.ri.researcher
Modifier and TypeClassDescriptionclass
Lab is a child element of researcher and provides a URI linking to the detailed representation of the lab for the researcher.class
The detailed representation of a researcher.class
Researcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.class
The role element defines a researcher's level of access in the system. -
Uses of Locatable in com.genologics.ri.role
Modifier and TypeClassDescriptionclass
Permission-link is a child element type of permissions and provides a URI linking to the detailed representation of a Permission.class
Researcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.class
The detailed representation of a Roleclass
Role-link is a child element type of roles and provides a URI linking to the detailed representation of a Role. -
Uses of Locatable in com.genologics.ri.routing
-
Uses of Locatable in com.genologics.ri.sample
Modifier and TypeClassDescriptionclass
Artifact is a child element of Sample and provides a URI linking to the detailed representation of the artifact for the Sample.class
Control Type provides a name and a URI linking to the detailed representation of the Control Type associated with the Sample.class
Project is a child element of Sample and provides a URI linking to the detailed representation of the Project for the Sample.class
The detailed representation of a sample.class
Sample-link is a child element type of samples and provides a URI linking to the detailed representation of a sample.class
Submitter is a child element of Sample and provides a URI linking to the detailed representation of the submitter for the Sample. -
Uses of Locatable in com.genologics.ri.stage
Modifier and TypeClassDescriptionclass
Protocol link for the stage.class
Protocol Step link for the stage.class
The detailed representation of a stage.class
Workflow link for the stage. -
Uses of Locatable in com.genologics.ri.step
Modifier and TypeClassDescriptionclass
class
Identifies the resource that represents the actions applied or to be applied by the step.class
Artifact is a child element of input-output-map and provides a link to an Artifact that was either an input or output of the Step for the input-output-map.class
Identifies the resource that represents the step that was automatically begun when the "Automatically start Next Step" option is enabled in a step's configuration.class
Provides a URI linking to a selected container to be used for placement.class
Typically, provides a URI linking to the input artifact.class
Sample next action or step.class
Provides input URI links.class
The instrument element provides a URI to the selected instrument for the step.class
Sample next action or step.class
Provides a URI linking to the output artifact and reagent label.class
Provides a URI linking to the output artifact and container placement.class
The detailed representation of a step's output artifact container placementsclass
Identifies the resource that represents the output placements for the step.class
The detailed representation of a step's pooled inputs.class
Identifies the resource that represents the pools added by the step.class
The detailed representation of a step.class
The current EPP status for a step (supports automatically triggered programs only).class
Identifies the resource that represents the program status for the step.class
Provides a URI linking to the reagent lot details.class
The list representation of a step's reagent lots.class
Identifies the resource that represents the reagent lots for the step.class
The detailed representation of a step's output artifact reagents.class
Identifies the resource that represents the reagents added by the step.class
The file element describes a shared result file output that will be displayed in the step-setup view.class
Identifies the configuration information for the step run.class
class
Identifies the resource that represents the details for the step.class
class
Identifies the resource that represents the setup for the step.class
Describes a user as required in the context of step escalations. -
Uses of Locatable in com.genologics.ri.stepconfiguration
Modifier and TypeClassDescriptionclass
Control-type-link is a child element type of controlTypes and provides a URI linking to the detailed representation of a ControlType.class
List of step transitions including the URI allowing access to the specific next stepclass
Process-type is a child element that provides a URI linking to the detailed representation of the process type that the step is associated with.class
Detailed representation of a Stepclass
Reagent-Kit-Link is an element providing a URI linking to the detailed representation of a reagent kit. -
Uses of Locatable in com.genologics.ri.version
-
Uses of Locatable in com.genologics.ri.workflowconfiguration
Modifier and TypeClassDescriptionclass
Protocol-link is a child element type of workflow and provides a URI linking to the detailed representation of a protocol.class
The detailed representation of a Stage (the portion of a workflow to which samples can be associated in order to be queued)class
The detailed representation of a Workflow.class
Workflow-link is a child element type of workflows and provides a URI linking to the detailed representation of a workflow. -
Uses of Locatable in org.cruk.clarity.api
Modifier and TypeMethodDescription<E extends Locatable>
voidClarityAPI.create
(E entity) Create an instance of the given entity on the server.<E extends Locatable>
voidClarityAPI.createAll
(Collection<E> entities) Create a batch of entities on the server.<E extends Locatable>
voidClarityAPI.delete
(E entity) Deletes an entity from the server.<E extends Locatable>
voidClarityAPI.deleteAll
(Collection<E> entities) Deletes a batch of entities from the server.Search for entities of the given type based on name value pairs.ClarityAPI.limsIdToUri
(String limsid, Class<E> entityClass) Convert the given LIMS id to a full URI for that entity.ClarityAPI.limsIdToUri
(String outerLimsid, String innerLimsid, Class<E> entityClass) Convert the given LIMS ids to a full URI for that entity.List all the objects of the given entity class.List an arbitrary number of objects of the given entity class.<E extends Locatable>
ELoad an entity using a link to that entity.<E extends Locatable>
ELoad an entity by its LIMS id.<E extends Locatable>
ELoad an entity by its two required LIMS ids.ClarityAPI.loadAll
(Collection<? extends LimsLink<E>> links) Fetch a collection of LIMS entities given in the collection.<E extends Locatable>
ERetrieve an entity using a String form of its URI.<E extends Locatable>
ERetrieve an entity by its URI.<E extends Locatable>
voidClarityAPI.update
(E entity) Update the given entity on the server.<E extends Locatable>
voidClarityAPI.updateAll
(Collection<E> entities) Updates a batch of entities. -
Uses of Locatable in org.cruk.clarity.api.cache
Modifier and TypeMethodDescriptionprotected <E extends Locatable>
EClarityAPICache.getFromWrapper
(org.cruk.clarity.api.cache.CacheElementWrapper wrapper) Get the object from its cache wrapper.ClarityAPICache.loadAll
(ProceedingJoinPoint pjp) Join point for theClarityAPI.loadAll
method.Modifier and TypeMethodDescriptionClarityAPICache.runSomething
(ProceedingJoinPoint pjp) Join point for the methods that take an object in to perform an operation and return an object as a result (not necessarily object passed in).Modifier and TypeMethodDescriptionClarityAPICache.keyFromLocatable
(Locatable thing) Extract the cache key value from the given object's URI.long
ClarityAPICache.versionFromLocatable
(Locatable thing) Extract the state value from the given object's URI, if such an entity can have a state value. -
Uses of Locatable in org.cruk.clarity.api.impl
Modifier and TypeFieldDescriptionClarityAPIImpl.entityToBatchRetrieveClassMap
Map of Locatable class to the class that provides the mass fetch or update operation.ClarityAPIImpl.entityToListClassMap
Map of Locatable class to the class that provides the list of links returned from listing or searching for objects of that type.Modifier and TypeMethodDescriptionClarityAPIImpl.checkCollectionHomogeneousAndUnique
(Collection<E> entities, boolean requireUri) Check that the given collection contains no nulls, that each item either has a URI or does not have a URI (depending onrequireUri
, that all objects in the collection are of the same class, and that, ifrequireUri
is true, there are no repeated URIs in the collection (ignoring state).ClarityAPIImpl.checkLinkCollectionHomogeneousAndUnique
(Collection<L> links) Check that the given collection of links contains no nulls, that each link has a URI, that all links in the collection are links to the same entity class, and that there are no repeated URIs in the collection (ignoring state).<E extends Locatable>
voidClarityAPIImpl.create
(E entity) Create an instance of the given entity on the server.<E extends Locatable>
voidClarityAPIImpl.createAll
(Collection<E> entities) Create a batch of entities on the server.<E extends Locatable>
voidClarityAPIImpl.delete
(E entity) Deletes an entity from the server.<E extends Locatable>
voidClarityAPIImpl.deleteAll
(Collection<E> entities) Deletes a batch of entities from the server.Search for entities of the given type based on name value pairs.ClarityAPIImpl.getBatchRetrieveClassForEntity
(Class<E> entityClass) Get the class that allow mass retrieve or update operations for the given entity class.ClarityAPIImpl.getQueryResultsClassForEntity
(Class<E> entityClass) Get the class that holds a list of links for the given entity when returned from a list or search operation.ClarityAPIInternal.getQueryResultsClassForEntity
(Class<E> entityClass) Get the class that holds a list of links for the given entity when returned from a list or search operation.ClarityAPIImpl.limsIdToUri
(String limsid, Class<E> entityClass) Convert the given LIMS id to a full URI for that entity.ClarityAPIImpl.limsIdToUri
(String outerLimsid, String innerLimsid, Class<E> entityClass) Convert the given LIMS ids to a full URI for that entity.List all the objects of the given entity class.List an arbitrary number of objects of the given entity class.<E extends Locatable>
ELoad an entity using a link to that entity.<E extends Locatable>
ELoad an entity by its LIMS id.<E extends Locatable>
ELoad an entity by its two required LIMS ids.ClarityAPIImpl.loadAll
(Collection<? extends LimsLink<E>> links) Fetch a collection of LIMS entities given in the collection.Convert the given LIMS id to a full URI for that entity without creating a URI object.Convert the given LIMS ids to a full URI for that entity without creating a URI object.protected <E extends Locatable>
voidClarityAPIImpl.reflectiveCollectionUpdate
(Collection<E> originals, List<E> retrieved) Update a collection of original entities with the fields from an equivalent list of freshly retrieved versions of the same entities.protected <E extends Locatable>
voidClarityAPIImpl.reorderBatchFetchList
(Collection<? extends Locatable> requestLinks, List<E> entities) Reorder a collection of entities into the same order given by their request objects.<E extends Locatable>
ERetrieve an entity using a String form of its URI.<E extends Locatable>
ERetrieve an entity by its URI.<E extends Locatable>
voidClarityAPIImpl.update
(E entity) Update the given entity on the server.<E extends Locatable>
voidClarityAPIImpl.updateAll
(Collection<E> entities) Updates a batch of entities.Modifier and TypeMethodDescriptionprotected String
Get an identifier for a locatable object from its URI.Modifier and TypeMethodDescriptionprotected <E extends Locatable>
voidClarityAPIImpl.reorderBatchFetchList
(Collection<? extends Locatable> requestLinks, List<E> entities) Reorder a collection of entities into the same order given by their request objects.