Uses of Interface
org.dspace.app.rest.projection.Projection
-
Packages that use Projection Package Description org.dspace.app.rest org.dspace.app.rest.converter org.dspace.app.rest.model org.dspace.app.rest.projection org.dspace.app.rest.repository org.dspace.app.rest.utils -
-
Uses of Projection in org.dspace.app.rest
Methods in org.dspace.app.rest with parameters of type Projection Modifier and Type Method Description org.springframework.data.domain.Page<WorkflowActionRest>WorkflowStepActionsLinkRepository. getActions(javax.servlet.http.HttpServletRequest request, String workflowStepName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)GET endpoint that returns the list of actions of a workflow step.org.springframework.data.domain.Page<CollectionRest>WorkflowDefinitionCollectionsLinkRepository. getCollections(javax.servlet.http.HttpServletRequest request, String workflowName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)GET endpoint that returns the list of collections that make an explicit use of the workflow-definition.org.springframework.data.domain.Page<WorkflowStepRest>WorkflowDefinitionStepsLinkRepository. getSteps(javax.servlet.http.HttpServletRequest request, String workflowName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)GET endpoint that returns the list of steps of a workflow-definition. -
Uses of Projection in org.dspace.app.rest.converter
Methods in org.dspace.app.rest.converter that return Projection Modifier and Type Method Description ProjectionConverterService. getProjection(String projectionName)Gets the projection with the given name, or the default (no-op) projection if null is given.Methods in org.dspace.app.rest.converter with parameters of type Projection Modifier and Type Method Description voidDiscoverFacetsConverter. addFacetValues(org.dspace.core.Context context, org.dspace.discovery.DiscoverResult searchResult, SearchResultsRest resultsRest, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)Fill the facet values information in the SearchResultsRest using the information in the api DiscoverResult object according to the configuration applied to the discovery queryAuthenticationTokenRestAuthenticationTokenConverter. convert(AuthenticationToken modelObject, Projection projection)AuthorizationRestAuthorizationConverter. convert(Authorization authz, Projection projection)AuthorizationFeatureRestAuthorizationFeatureConverter. convert(AuthorizationFeature feature, Projection projection)BitstreamRestBitstreamConverter. convert(org.dspace.content.Bitstream obj, Projection projection)BitstreamFormatRestBitstreamFormatConverter. convert(org.dspace.content.BitstreamFormat obj, Projection projection)BrowseIndexRestBrowseIndexConverter. convert(org.dspace.browse.BrowseIndex obj, Projection projection)ClaimedTaskRestClaimedTaskConverter. convert(org.dspace.xmlworkflow.storedcomponents.ClaimedTask obj, Projection projection)SearchConfigurationRestDiscoverConfigurationConverter. convert(org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)FacetResultsRestDiscoverFacetResultsConverter. convert(org.dspace.core.Context context, String facetName, String prefix, String query, List<String> dsoTypes, String dsoScope, List<SearchFilter> searchFilters, org.dspace.discovery.DiscoverResult searchResult, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, org.springframework.data.domain.Pageable page, Projection projection)SearchResultsRestDiscoverFacetsConverter. convert(org.dspace.core.Context context, String query, List<String> dsoTypes, String configurationName, String dsoScope, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, org.dspace.discovery.DiscoverResult searchResult, Projection projection)SearchFacetValueRestDiscoverFacetValueConverter. convert(org.dspace.discovery.DiscoverResult.FacetResult value, Projection projection)SearchResultsRestDiscoverResultConverter. convert(org.dspace.core.Context context, String query, List<String> dsoTypes, String configurationName, String scope, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, org.dspace.discovery.DiscoverResult searchResult, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)RDSpaceConverter. convert(M modelObject, Projection projection)RDSpaceObjectConverter. convert(M obj, Projection projection)ParameterValueRestDSpaceRunnableParameterConverter. convert(org.dspace.scripts.DSpaceCommandLineParameter dSpaceCommandLineParameter, Projection projection)EntityTypeRestEntityTypeConverter. convert(org.dspace.content.EntityType obj, Projection projection)EPersonRestEPersonConverter. convert(org.dspace.eperson.EPerson obj, Projection projection)ExternalSourceEntryRestExternalSourceEntryRestConverter. convert(org.dspace.external.model.ExternalDataObject modelObject, Projection projection)ExternalSourceRestExternalSourceRestConverter. convert(org.dspace.external.provider.ExternalDataProvider modelObject, Projection projection)GroupRestGroupConverter. convert(org.dspace.eperson.Group obj, Projection projection)HarvestedCollectionRestHarvestedCollectionConverter. convert(org.dspace.harvest.HarvestedCollection obj, Projection projection)ItemRestItemConverter. convert(org.dspace.content.Item obj, Projection projection)MetadataRestMetadataConverter. convert(MetadataValueList metadataValues, Projection projection)MetadataFieldRestMetadataFieldConverter. convert(org.dspace.content.MetadataField obj, Projection projection)MetadataSchemaRestMetadataSchemaConverter. convert(org.dspace.content.MetadataSchema obj, Projection projection)MetadataValueRestMetadataValueConverter. convert(org.dspace.content.MetadataValue metadataValue, Projection projection)PoolTaskRestPoolTaskConverter. convert(org.dspace.xmlworkflow.storedcomponents.PoolTask obj, Projection projection)ProcessRestProcessConverter. convert(org.dspace.scripts.Process process, Projection projection)RelationshipRestRelationshipConverter. convert(org.dspace.content.Relationship obj, Projection projection)RelationshipTypeRestRelationshipTypeConverter. convert(org.dspace.content.RelationshipType obj, Projection projection)ResourcePolicyRestResourcePolicyConverter. convert(org.dspace.authorize.ResourcePolicy obj, Projection projection)ScriptRestScriptConverter. convert(org.dspace.scripts.configuration.ScriptConfiguration scriptConfiguration, Projection projection)SiteRestSiteConverter. convert(org.dspace.content.Site obj, Projection projection)SubmissionCCLicenseRestSubmissionCCLicenseConverter. convert(org.dspace.license.CCLicense modelObject, Projection projection)Convert a CCLicense to its REST representationSubmissionCCLicenseFieldRestSubmissionCCLicenseFieldConverter. convert(org.dspace.license.CCLicenseField modelObject, Projection projection)Convert a CCLicenseField to its REST representationSubmissionCCLicenseFieldEnumRestSubmissionCCLicenseFieldEnumConverter. convert(org.dspace.license.CCLicenseFieldEnum modelObject, Projection projection)Convert a CCLicenseFieldEnum to its REST representationSubmissionCCLicenseUrlRestSubmissionCCLicenseUrlConverter. convert(SubmissionCCLicenseUrl modelObject, Projection projection)Convert a Submission CC License Url String to its REST representationSubmissionDefinitionRestSubmissionDefinitionConverter. convert(org.dspace.app.util.SubmissionConfig obj, Projection projection)SubmissionFormRestSubmissionFormConverter. convert(org.dspace.app.util.DCInputSet obj, Projection projection)SubmissionSectionRestSubmissionSectionConverter. convert(org.dspace.app.util.SubmissionStepConfig step, Projection projection)TemplateItemRestTemplateItemConverter. convert(TemplateItem templateItem, Projection projection)UsageReportRestUsageReportConverter. convert(UsageReportRest modelObject, Projection projection)VersionRestVersionConverter. convert(org.dspace.versioning.Version modelObject, Projection projection)VersionHistoryRestVersionHistoryConverter. convert(org.dspace.versioning.VersionHistory modelObject, Projection projection)VocabularyEntryDetailsRestVocabularyEntryDetailsRestConverter. convert(org.dspace.content.authority.Choice choice, Projection projection)VocabularyRestVocabularyRestConverter. convert(org.dspace.content.authority.ChoiceAuthority authority, Projection projection)WorkflowActionRestWorkflowActionConverter. convert(org.dspace.xmlworkflow.state.actions.WorkflowActionConfig modelObject, Projection projection)WorkflowDefinitionRestWorkflowDefinitionConverter. convert(org.dspace.xmlworkflow.state.Workflow modelObject, Projection projection)WorkflowItemRestWorkflowItemConverter. convert(org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem obj, Projection projection)WorkflowStepRestWorkflowStepConverter. convert(org.dspace.xmlworkflow.state.Step modelObject, Projection projection)WorkspaceItemRestWorkspaceItemConverter. convert(org.dspace.content.WorkspaceItem obj, Projection projection)protected voidAInprogressItemConverter. fillFromModel(T obj, R witem, Projection projection)HarvestedCollectionRestHarvestedCollectionConverter. fromModel(org.dspace.harvest.HarvestedCollection obj, org.dspace.content.Collection collection, List<Map<String,String>> metadata_configs, Projection projection)<M,R>
RConverterService. toRest(M modelObject, Projection projection)Converts the given model object to a rest object, using the appropriateDSpaceConverterand the given projection.<M,R>
org.springframework.data.domain.Page<R>ConverterService. toRestPage(List<M> modelObjects, org.springframework.data.domain.Pageable pageable, long total, Projection projection)Converts a list of ModelObjects to a page of Rest Objects using the givenProjectionThis method differences in the sense that we define a total here instead of the size of the list because this method will be called if the list is limited through a DB call already and thus we need to give the total amount of records in the DB; not the size of the given list<M,R>
org.springframework.data.domain.Page<R>ConverterService. toRestPage(List<M> modelObjects, org.springframework.data.domain.Pageable pageable, Projection projection)Converts a list of model objects to a page of rest objects using the givenProjection. -
Uses of Projection in org.dspace.app.rest.model
Methods in org.dspace.app.rest.model that return Projection Modifier and Type Method Description ProjectionRestAddressableModel. getProjection()Methods in org.dspace.app.rest.model with parameters of type Projection Modifier and Type Method Description voidRestAddressableModel. setProjection(Projection projection) -
Uses of Projection in org.dspace.app.rest.projection
Classes in org.dspace.app.rest.projection that implement Projection Modifier and Type Class Description classAbstractProjectionAbstract base class for projections.classCompositeProjectionA projection that combines the behavior of multiple projections.classDefaultProjectionThe default projection.classEmbedRelsProjectionProjection that allows a given set of rels to be embedded.classFullProjectionCatch-all projection that allows embedding of all subresources.classSpecificLevelProjectionThis Projection will allow us to specify how many levels deep we're going to embed resources onto the requested HalResource.Fields in org.dspace.app.rest.projection declared as Projection Modifier and Type Field Description static ProjectionProjection. DEFAULTThe default projection.Constructor parameters in org.dspace.app.rest.projection with type arguments of type Projection Constructor Description CompositeProjection(List<Projection> projections) -
Uses of Projection in org.dspace.app.rest.repository
Methods in org.dspace.app.rest.repository with parameters of type Projection Modifier and Type Method Description org.springframework.data.domain.Page<VocabularyEntryRest>VocabularyEntryLinkRepository. filter(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)GroupRestCollectionAdminGroupLinkRepository. getAdminGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method is responsible for retrieving the AdminGroup of a CollectionGroupRestCommunityAdminGroupLinkRepository. getAdminGroup(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method is responsible for retrieving the AdminGroup of a CommunityGroupRestCollectionBitstreamReadGroupLinkRepository. getBitstreamReadGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method is responsible for retrieving the BitstreamReadGroup of a Collectionorg.springframework.data.domain.Page<BitstreamRest>BundleBitstreamLinkRepository. getBitstreams(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BundleRestBitstreamBundleLinkRepository. getBundle(javax.servlet.http.HttpServletRequest request, UUID bitstreamId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<BundleRest>ItemBundleLinkRepository. getBundles(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<VocabularyEntryDetailsRest>VocabularyEntryDetailsChildrenLinkRepository. getChildren(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<CollectionRest>CommunityCollectionLinkRepository. getCollections(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)EPersonRestAuthorizationEpersonLinkRepository. getEperson(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)AuthorizationFeatureRestAuthorizationFeatureLinkRepository. getFeature(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<BitstreamRest>ProcessFilesLinkRepository. getFilesFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve all the files from the processProcessFileTypesRestProcessFileTypesLinkRepository. getFileTypesFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This will be the admin only endpoint that returns theProcessFileTypesRestconstructed with the values found in the Bitstreams of the Process with the given ProcessIdBitstreamFormatRestBitstreamFormatLinkRepository. getFormat(javax.servlet.http.HttpServletRequest request, UUID bitstreamId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<GroupRest>EPersonGroupLinkRepository. getGroups(javax.servlet.http.HttpServletRequest request, UUID epersonId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<GroupRest>GroupGroupLinkRepository. getGroups(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)ItemRestBundleItemLinkRepository. getItem(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)Get the item where the provided bundle resides inGroupRestCollectionItemReadGroupLinkRepository. getItemReadGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method is responsible for retrieving the ItemReadGroup of a CollectionVersionRestItemVersionLinkRepository. getItemVersion(javax.servlet.http.HttpServletRequest request, UUID itemUuid, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will return the VersionRest object from the Item that is associated with the given itemUuidLicenseRestCollectionLicenseLinkRepository. getLicense(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable pageable, Projection projection)BitstreamRestCollectionLogoLinkRepository. getLogo(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BitstreamRestCommunityLogoLinkRepository. getLogo(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<CollectionRest>ItemMappedCollectionLinkRepository. getMappedCollections(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<ItemRest>CollectionMappedItemLinkRepository. getMappedItems(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<GroupRest>GroupEPersonLinkRepository. getMembers(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BaseObjectRestAuthorizationObjectLinkRepository. getObject(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BitstreamRestProcessOutputLinkRepository. getOutputFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve the output for theProcessas defined through the given ID in the rest call.CollectionRestItemOwningCollectionLinkRepository. getOwningCollection(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)VocabularyEntryDetailsRestVocabularyEntryDetailsParentLinkRepository. getParent(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)CommunityRestCollectionParentCommunityLinkRepository. getParentCommunity(javax.servlet.http.HttpServletRequest httpServletRequest, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method retrieves the ParentCommunity object for the Collection which is defined by the given collectionId It'll transform this Parent Community to a REST object and return thisCommunityRestCommunityParentCommunityLinkRepository. getParentCommunity(javax.servlet.http.HttpServletRequest httpServletRequest, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method retrieves the ParentCommunity object for the Community which is defined by the given communityId It'll transform this Parent Community to a REST object and return thisDSpaceObjectRestGroupParentObjectLinkRepository. getParentObject(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This returns the DSpace Object (Community, Collection) belonging to this Group.BitstreamRestBundlePrimaryBitstreamLinkRepository. getPrimaryBitstream(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)org.springframework.data.domain.Page<RelationshipRest>ItemRelationshipLinkRepository. getRelationships(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BitstreamRestProcessFilesLinkRepository. getResource(javax.servlet.http.HttpServletRequest request, String processId, String fileType, org.springframework.data.domain.Pageable pageable, Projection projection)This method will retrieve a bitstream for the given processId for the given fileTypeSearchResultsRestDiscoveryRestRepository. getSearchObjects(String query, List<String> dsoTypes, String dsoScope, String configuration, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, Projection projection)WorkflowStepRestClaimedTaskStepLinkRepository. getStep(javax.servlet.http.HttpServletRequest request, Integer claimedTaskId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve theWorkflowStepRestobject for theClaimedTaskwith the given idWorkflowStepRestPoolTaskStepLinkRepository. getStep(javax.servlet.http.HttpServletRequest request, Integer poolTaskId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve theWorkflowStepRestobject for thePoolTaskwith the given idWorkflowStepRestWorkflowItemStepLinkRepository. getStep(javax.servlet.http.HttpServletRequest request, Integer workflowItemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve theWorkflowStepRestobject for theWorkflowItemwith the given idorg.springframework.data.domain.Page<CommunityRest>CommunitySubcommunityLinkRepository. getSubcommunities(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)GroupRestCollectionSubmitterGroupLinkRepository. getSubmittersGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method is responsible for retrieving the Submittergroup of a CollectionCollectionRestItemTemplateItemOfLinkRepository. getTemplateItemOf(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BitstreamRestBitstreamThumbnailLinkRepository. getThumbnail(javax.servlet.http.HttpServletRequest request, UUID bitstreamId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)BitstreamRestItemThumbnailLinkRepository. getThumbnail(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)VersionHistoryRestVersionHistoryLinkRepository. getVersionHistory(javax.servlet.http.HttpServletRequest request, Integer versionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will retrieve the VersionHistoryRest object from the Version that is found by the associated versionId parameterItemRestVersionItemLinkRepository. getVersionItem(javax.servlet.http.HttpServletRequest request, Integer versionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will return the ItemRest object constructed from the Item object which is found in the Version that will be found through the versionId parameterorg.springframework.data.domain.Page<VersionRest>VersionsLinkRepository. getVersions(javax.servlet.http.HttpServletRequest request, Integer versionHistoryId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)This method will return a page of VersionRest objects found through the VersionHistory object that is resolved from the versionHistoryId parameterorg.springframework.data.domain.Page<BrowseEntryRest>BrowseEntryLinkRepository. listBrowseEntries(javax.servlet.http.HttpServletRequest request, String browseName, org.springframework.data.domain.Pageable pageable, Projection projection)org.springframework.data.domain.Page<ItemRest>BrowseItemLinkRepository. listBrowseItems(javax.servlet.http.HttpServletRequest request, String browseName, org.springframework.data.domain.Pageable pageable, Projection projection) -
Uses of Projection in org.dspace.app.rest.utils
Methods in org.dspace.app.rest.utils that return Projection Modifier and Type Method Description ProjectionUtils. obtainProjection()Gets the effective projection requested by the current servlet request, orDefaultProjectionif none is specified.Methods in org.dspace.app.rest.utils with parameters of type Projection Modifier and Type Method Description VocabularyRestAuthorityUtils. convertAuthority(org.dspace.content.authority.ChoiceAuthority source, String authorityName, Projection projection)TODO the authorityName MUST be a part of ChoiceAuthority modelVocabularyEntryRestAuthorityUtils. convertEntry(org.dspace.content.authority.Choice choice, String authorityName, boolean storeAuthority, Projection projection)This utility method is currently a workaround to enrich the REST object with information from the parent vocabulary that is not referenced by the Choice modelVocabularyEntryDetailsRestAuthorityUtils. convertEntryDetails(org.dspace.content.authority.Choice choice, String authorityName, boolean isHierarchical, Projection projection)TODO the authorityName MUST be a part of Choice model
-