Uses of Class
ubic.gemma.rest.util.args.PlatformArg

Packages that use PlatformArg

Package	Description
ubic.gemma.rest
ubic.gemma.rest.util.args

Uses of PlatformArg in ubic.gemma.rest

Methods in ubic.gemma.rest with parameters of type PlatformArg

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	PlatformsWebService.getPlatformAnnotations(PlatformArg<?> platformArg, String typeArg, Boolean download, Boolean force)	Retrieves the annotation file for the given platform.
Object	PlatformsWebService.getPlatformDatasets(PlatformArg<?> platformArg, OffsetArg offset, LimitArg limit, CursorArg cursorArg)	Retrieves experiments in the given platform.
Object	PlatformsWebService.getPlatformElement(PlatformArg<?> platformArg, CompositeSequenceArrayArg probesArg, OffsetArg offset, LimitArg limit, CursorArg cursorArg, boolean withSequence, boolean withGenes)	Retrieves composite sequences (elements) of the given platform.
Object	PlatformsWebService.getPlatformElementGenes(PlatformArg<?> platformArg, CompositeSequenceArg<?> probeArg, OffsetArg offset, LimitArg limit, CursorArg cursorArg)	Retrieves the genes on the given platform element.
ResponseDataObject<CompositeSequenceValueObject>	PlatformsWebService.getPlatformElementMappingSummary(PlatformArg<?> platformArg, CompositeSequenceArg<?> probeArg)	Retrieves the per-probe gene-mapping summary (BLAT alignments + biological-sequence metadata + supported genes) for a single probe on a given platform.
jakarta.ws.rs.core.Response	PlatformsWebService.getPlatformElementPslTrack(PlatformArg<?> platformArg, CompositeSequenceArg<?> probeArg, Boolean download)	Retrieves the BLAT alignments of a single probe as a UCSC Genome Browser custom track, in PSL format.
Object	PlatformsWebService.getPlatformElements(PlatformArg<?> platformArg, OffsetArg offset, LimitArg limit, CursorArg cursorArg, boolean withSequence, boolean withGenes, QueryArg geneQuery, FilterArg<CompositeSequence> filter)	Retrieves the composite sequences (elements) for the given platform.
Object	PlatformsWebService.getPlatformTickets(PlatformArg<?> platformArg, CursorArg cursorArg, LimitArg limitArg)	Retrieves the open curation tickets for a given platform.
ResponseDataObject<ArrayDesignValueObject>	AdminWebService.regeneratePlatformReport(PlatformArg<?> platformArg)	Regenerate the cached report for ONE platform, synchronously.
SearchWebService.SearchResultsResponseDataObject	SearchWebService.search(QueryArg query, DatasetArg<?> datasetArg, TaxonArg<?> taxonArg, PlatformArg<?> platformArg, List<String> resultTypes, LimitArg limit, ExcludeArg<SearchResult<?>> excludeArg, boolean useGeneOntology, boolean inferRelations)	Search everything subject to taxon and platform constraints.

Uses of PlatformArg in ubic.gemma.rest.util.args

Subclasses of PlatformArg in ubic.gemma.rest.util.args

Modifier and Type	Class	Description
class	PlatformIdArg	Long argument type for platform API, referencing the platform ID.
class	PlatformStringArg	String argument type for platform API, referencing the Platform short name.

Methods in ubic.gemma.rest.util.args that return PlatformArg

Modifier and Type	Method	Description
static PlatformArg<?>	PlatformArg.valueOf(String s)	Used by RS to parse value of request parameters.

Methods in ubic.gemma.rest.util.args with parameters of type PlatformArg

Modifier and Type	Method	Description
Filters	PlatformArgService.getElementFilters(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg)	Filters for the /{platform}/elements/{probes} endpoints: the platform scope AND the {probes} id/name set restriction.
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, int limit, int offset)	Retrieves the design elements of the platform that this argument represents.
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, int limit, int offset, boolean withSequence)	Variant that opt-in hydrates the probe-sequence projection (sequence + length) via a single batch HQL after the main page is fetched.
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, int limit, int offset, boolean withSequence, boolean withGenes, Collection<Long> geneIds)	Full-projection variant: adds the opt-in gene column (withGenes) and the opt-in gene restriction (geneIds).
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, Filters userFilters, Collection<Long> geneIds, int limit, int offset, boolean withSequence, boolean withGenes)	Widest offset-mode variant: user-supplied filter= conjunct on top of everything else.
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg, int limit, int offset, boolean withSequence)	Offset-mode variant of PlatformArgService.getElementsByCursor(PlatformArg, CompositeSequenceArrayArg, Cursor, int, boolean).
Slice<CompositeSequenceValueObject>	PlatformArgService.getElements(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg, int limit, int offset, boolean withSequence, boolean withGenes)	Probe-set variant with the opt-in gene column.
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, Cursor cursor, int limit)	Cursor-mode counterpart to PlatformArgService.getElements(PlatformArg, int, int): keyset pagination over the design elements of a single platform, always sorted by ascending id (the primary key, indexed and unique) — see CURSOR_PAGINATION_STEP1_PLAN.md step 1e.
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, Cursor cursor, int limit, boolean withSequence)	Cursor-mode variant of PlatformArgService.getElements(PlatformArg, int, int, boolean).
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, Cursor cursor, int limit, boolean withSequence, boolean withGenes, Collection<Long> geneIds)	Cursor-mode variant of PlatformArgService.getElements(PlatformArg, int, int, boolean, boolean, Collection).
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, Filters userFilters, Collection<Long> geneIds, Cursor cursor, int limit, boolean withSequence, boolean withGenes)	Widest cursor-mode variant; see PlatformArgService.getElements(PlatformArg, Filters, Collection, int, int, boolean, boolean).
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg, Cursor cursor, int limit)	Cursor-mode counterpart to FilteringVoEnabledService.loadValueObjects(Filters, Sort, int, int) scoped to a single platform AND a fixed set of probe identifiers (the /{platform}/elements/{probes} endpoint) — see CURSOR_PAGINATION_STEP1_PLAN.md step 1j.
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg, Cursor cursor, int limit, boolean withSequence)	Cursor-mode + probe-set variant of PlatformArgService.getElements(PlatformArg, int, int, boolean).
CursorPage<CompositeSequenceValueObject>	PlatformArgService.getElementsByCursor(PlatformArg<?> arg, CompositeSequenceArrayArg probesArg, Cursor cursor, int limit, boolean withSequence, boolean withGenes)	Cursor-mode + probe-set variant with the opt-in gene column.
Slice<ExpressionExperimentValueObject>	PlatformArgService.getExperiments(PlatformArg<?> arg, int limit, int offset)	Retrieves the Datasets of the Platform that this argument represents.
CursorPage<ExpressionExperimentValueObject>	PlatformArgService.getExperimentsByCursor(PlatformArg<?> arg, Cursor cursor, int limit)	Cursor-mode counterpart to PlatformArgService.getExperiments(PlatformArg, int, int): keyset pagination over the datasets that use a single platform, always sorted by ascending id (the primary key, indexed and unique) — see CURSOR_PAGINATION_STEP1_PLAN.md step 1f.