Uses of Interface
com.genologics.ri.Locatable
Packages that use 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
Classes in com.genologics.ri with type parameters of type LocatableModifier and TypeInterfaceDescriptioninterfaceInterface for classes that are links to real LIMS objects.interfaceMarker interface that indicates a locatable object can be linked to.Subinterfaces of Locatable in com.genologics.riModifier and TypeInterfaceDescriptioninterfaceLimsEntity<E extends LimsEntity<E>>Interface for all objects that are real LIMS entities (i.e. not links or other references).interfaceLimsEntityLink<E extends LimsEntity<E>>Interface for links to LimsEntity objects.interfaceLimsEntityLinkable<E extends LimsEntity<E>>Interface for entities and links to entities that are identifiable in the system (i.e. have a LIMS id).interfaceInterface for classes that are links to real LIMS objects.interfaceMarker interface that indicates a locatable object can be linked to.Classes in com.genologics.ri that implement LocatableModifier and TypeClassDescriptionclassContainer is a child element of location and provides a URI linking to the detailed representation of the Container for the location.classAn external id is a reference to an identifier in an external system that contains additional information about a representation within the API.classA link provides a URI linking to an additional resource.classLocation provides a URI linking to the detailed representation of a Container along with the well location within that Container.classThe link to a page of additional content.Methods in com.genologics.ri with parameters of type LocatableModifier and TypeMethodDescriptionstatic StringLink.limsIdFromUri(Locatable thing) Extract the LIMS identifier from the URI of a Locatable object. -
Uses of Locatable in com.genologics.ri.artifact
Classes in com.genologics.ri.artifact that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of an Artifact.classArtifact 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.classArtifact-link is a child element type of artifacts and provides a URI linking to the detailed representation of an artifact.classProvide a URI linking to the control type if this artifact is a control sample.classThe detailed representation of the demultiplexing of a pooled artifact.classDetails of an individual artifact that is part of a pooled artifact.classThe details of a sample that is part of a pooled artifact.classIdentifies the resource that will demultiplex this artifact.classclassParent-process is a child element of Artifact and provides a URI linking to the detailed representation of the process that produced the Artifact.classThe details of the pooling step that created the pooled sample(s).classSample is a child element of Artifact and provides a URI linking to the detailed representation of a submitted Sample for the Artifact.classProvides links to workflow stages, stage names and their respective statuses. -
Uses of Locatable in com.genologics.ri.artifactgroup
Classes in com.genologics.ri.artifactgroup that implement LocatableModifier and TypeClassDescriptionclassArtifactGroups are created by the Lab Scientist interface for each workflow.classartifactGroup-link is a child element type of artifactGroup and provides a URI linking to the detailed representation of a artifactGroup.classArtifacts 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
Classes in com.genologics.ri.automation that implement LocatableModifier and TypeClassDescriptionclassThe automation element integrates the process with the Automation Worker (previously called External Program Plugin or EPP).classclassProvides links to process types the automation is enabled on. -
Uses of Locatable in com.genologics.ri.configuration
Classes in com.genologics.ri.configuration that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of the configuration of a user-defined field.classField definition represents a user-defined field configured in the parent entity.classThe detailed representation of the configuration of a user defined type.classType-definition provides a URI linking to the user defined type associated with the user-defined field, if applicable.classUdfconfig-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.classUdtconfig-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
Classes in com.genologics.ri.container that implement LocatableModifier and TypeClassDescriptionclassclassContainer-link is a child element type of containers and provides a URI linking to the detailed representation of a container.classContainer-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.classPlacement 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
Classes in com.genologics.ri.containertype that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of a container type.classContainer-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
Classes in com.genologics.ri.controltype that implement LocatableModifier and TypeClassDescriptionclassclassControl-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
Classes in com.genologics.ri.file that implement LocatableModifier and TypeClassDescriptionclassThe file element contains information about a file in the system.classThe file-link type provides a URI that links to information about a file in the system. -
Uses of Locatable in com.genologics.ri.instrument
Classes in com.genologics.ri.instrument that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of an instrument.classInstrument-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
Classes in com.genologics.ri.instrumenttype that implement LocatableModifier and TypeClassDescriptionclassAn instrument describes properties common to all instruments of that type.classclass -
Uses of Locatable in com.genologics.ri.lab
Classes in com.genologics.ri.lab that implement Locatable -
Uses of Locatable in com.genologics.ri.permission
Classes in com.genologics.ri.permission that implement Locatable -
Uses of Locatable in com.genologics.ri.process
Classes in com.genologics.ri.process that implement LocatableModifier and TypeClassDescriptionclassArtifact 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.classThe detailed representation of a process.classThe instrument element provides a URI to the instrument that is responsible for running the process.classParent-process is a child element of Artifact and provides a URI linking to the Process that created the Artifact.classProcess-link is a child element type of process and provides a URI linking to the detailed representation of a process.classProcess-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.classTechnician 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
Classes in com.genologics.ri.processexecution that implement LocatableModifier and TypeClassDescriptionclassThe input element provides URIs to one or more Artifacts that will be used by the Process.classThe instrument element provides a URI to the instrument that is responsible for running the process.classThe technician element provides a URI to the user that is responsible for the Process. -
Uses of Locatable in com.genologics.ri.processtemplate
Classes in com.genologics.ri.processtemplate that implement LocatableModifier and TypeClassDescriptionclassThe 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.classThe detailed representation of a Process Template.classprocess-template-link is a child element type of Process Templates and provides a URI linking to the detailed representation of a Process Template.classProcess-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.classTechnician 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
Classes in com.genologics.ri.processtype that implement LocatableModifier and TypeClassDescriptionclassclassclassThe process-type element contains the XML representation of a type of process configured in the system.classProcess-type-link is a child element type of process types and provides a URI linking to the detailed representation of a process type.classReagent-kit-link is a child element type of reagentKits and provides a URI linking to the detailed representation of a ReagentKit.classType-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
Classes in com.genologics.ri.project that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of a Project.classProject-link is a child element type of projects and provides a URI linking to the detailed representation of a project.classResearcher 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
Classes in com.genologics.ri.protocolconfiguration that implement LocatableModifier and TypeClassDescriptionclassDetailed representation of a protocol.class -
Uses of Locatable in com.genologics.ri.queue
Classes in com.genologics.ri.queue that implement Locatable -
Uses of Locatable in com.genologics.ri.reagentkit
Classes in com.genologics.ri.reagentkit that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of a reagent kit.classReagent-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
Classes in com.genologics.ri.reagentlot that implement LocatableModifier and TypeClassDescriptionclassReagent-Kit-Link is an element providing a URI linking to the detailed representation of a reagent kit.classThe detailed representation of a Reagent LotclassReagent-lot-link is a child element type of Reagent Lots and provides a URI linking to the detailed representation of a Reagent Lot.classResearcher is a child element of the reagent lot. -
Uses of Locatable in com.genologics.ri.reagenttype
Classes in com.genologics.ri.reagenttype that implement LocatableModifier and TypeClassDescriptionclassThe detailed representation of a reagent type.classReagent-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
Classes in com.genologics.ri.researcher that implement LocatableModifier and TypeClassDescriptionclassLab is a child element of researcher and provides a URI linking to the detailed representation of the lab for the researcher.classThe detailed representation of a researcher.classResearcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.classThe role element defines a researcher's level of access in the system. -
Uses of Locatable in com.genologics.ri.role
Classes in com.genologics.ri.role that implement LocatableModifier and TypeClassDescriptionclassPermission-link is a child element type of permissions and provides a URI linking to the detailed representation of a Permission.classResearcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.classThe detailed representation of a RoleclassRole-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
Classes in com.genologics.ri.routing that implement Locatable -
Uses of Locatable in com.genologics.ri.sample
Classes in com.genologics.ri.sample that implement LocatableModifier and TypeClassDescriptionclassArtifact is a child element of Sample and provides a URI linking to the detailed representation of the artifact for the Sample.classControl Type provides a name and a URI linking to the detailed representation of the Control Type associated with the Sample.classProject is a child element of Sample and provides a URI linking to the detailed representation of the Project for the Sample.classThe detailed representation of a sample.classSample-link is a child element type of samples and provides a URI linking to the detailed representation of a sample.classSubmitter 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
Classes in com.genologics.ri.stage that implement LocatableModifier and TypeClassDescriptionclassProtocol link for the stage.classProtocol Step link for the stage.classThe detailed representation of a stage.classWorkflow link for the stage. -
Uses of Locatable in com.genologics.ri.step
Classes in com.genologics.ri.step that implement LocatableModifier and TypeClassDescriptionclassclassIdentifies the resource that represents the actions applied or to be applied by the step.classArtifact 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.classIdentifies the resource that represents the step that was automatically begun when the "Automatically start Next Step" option is enabled in a step's configuration.classProvides a URI linking to a selected container to be used for placement.classTypically, provides a URI linking to the input artifact.classSample next action or step.classProvides input URI links.classThe instrument element provides a URI to the selected instrument for the step.classSample next action or step.classProvides a URI linking to the output artifact and reagent label.classProvides a URI linking to the output artifact and container placement.classThe detailed representation of a step's output artifact container placementsclassIdentifies the resource that represents the output placements for the step.classThe detailed representation of a step's pooled inputs.classIdentifies the resource that represents the pools added by the step.classThe detailed representation of a step.classThe current EPP status for a step (supports automatically triggered programs only).classIdentifies the resource that represents the program status for the step.classProvides a URI linking to the reagent lot details.classThe list representation of a step's reagent lots.classIdentifies the resource that represents the reagent lots for the step.classThe detailed representation of a step's output artifact reagents.classIdentifies the resource that represents the reagents added by the step.classThe file element describes a shared result file output that will be displayed in the step-setup view.classIdentifies the configuration information for the step run.classclassIdentifies the resource that represents the details for the step.classclassIdentifies the resource that represents the setup for the step.classDescribes a user as required in the context of step escalations. -
Uses of Locatable in com.genologics.ri.stepconfiguration
Classes in com.genologics.ri.stepconfiguration that implement LocatableModifier and TypeClassDescriptionclassControl-type-link is a child element type of controlTypes and provides a URI linking to the detailed representation of a ControlType.classList of step transitions including the URI allowing access to the specific next stepclassProcess-type is a child element that provides a URI linking to the detailed representation of the process type that the step is associated with.classDetailed representation of a StepclassReagent-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
Classes in com.genologics.ri.version that implement Locatable -
Uses of Locatable in com.genologics.ri.workflowconfiguration
Classes in com.genologics.ri.workflowconfiguration that implement LocatableModifier and TypeClassDescriptionclassProtocol-link is a child element type of workflow and provides a URI linking to the detailed representation of a protocol.classThe detailed representation of a Stage (the portion of a workflow to which samples can be associated in order to be queued)classThe detailed representation of a Workflow.classWorkflow-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
Methods in org.cruk.clarity.api with type parameters of type LocatableModifier 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
Methods in org.cruk.clarity.api.cache with type parameters of type LocatableModifier 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.loadAllmethod.Methods in org.cruk.clarity.api.cache that return LocatableModifier 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).Methods in org.cruk.clarity.api.cache with parameters of type LocatableModifier and TypeMethodDescriptionClarityAPICache.keyFromLocatable(Locatable thing) Extract the cache key value from the given object's URI.longClarityAPICache.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
Fields in org.cruk.clarity.api.impl with type parameters of type LocatableModifier and TypeFieldDescriptionClarityAPIImpl.entityToBatchRetrieveClassMapMap of Locatable class to the class that provides the mass fetch or update operation.ClarityAPIImpl.entityToListClassMapMap of Locatable class to the class that provides the list of links returned from listing or searching for objects of that type.Methods in org.cruk.clarity.api.impl with type parameters of type LocatableModifier 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, ifrequireUriis 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.Methods in org.cruk.clarity.api.impl with parameters of type LocatableModifier and TypeMethodDescriptionprotected StringGet an identifier for a locatable object from its URI.Method parameters in org.cruk.clarity.api.impl with type arguments of type LocatableModifier 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.