Views#

class tom_dataproducts.views.DataProductDeleteView(**kwargs)[source]#

View that handles the deletion of a DataProduct. Requires authentication.

check_permissions(request)[source]#

Checks if request.user has all permissions returned by get_required_permissions method.

Parameters:: request – Original request.

form_valid(form)[source]#

Method that handles DELETE requests for this view. It performs the following actions in order: 1. Deletes all ReducedDatum objects associated with the DataProduct. 2. Deletes the file referenced by the DataProduct. 3. Deletes the DataProduct object from the database.

Parameters:: form (django.forms.Form) – Django form instance containing the data for the DELETE request.
Returns:: HttpResponseRedirect to the success URL.
Return type:: HttpResponseRedirect

get_context_data(*args, **kwargs)[source]#

Adds the referer to the query parameters as “next” and returns the context dictionary.

Returns:: context dictionary
Return type:: dict

get_required_permissions(request=None)[source]#

Returns list of permissions in format <app_label>.<codename> that should be checked against request.user and object. By default, it returns list from permission_required attribute.

Parameters:: request – Original request.

get_success_url()[source]#

Gets the URL specified in the query params by “next” if it exists, otherwise returns the URL for home.

Returns:: referer or the index URL
Return type:: str

model#: alias of DataProduct

class tom_dataproducts.views.DataProductFeatureView(**kwargs)[source]#

View that handles the featuring of DataProduct``s. A featured ``DataProduct is displayed on the TargetDetailView.

get(request, *args, **kwargs)[source]#: Method that handles the GET requests for this view. Sets all other DataProduct``s to unfeatured in the database, and sets the specified ``DataProduct to featured. Caches the featured image. Deletes previously featured images from the cache.

class tom_dataproducts.views.DataProductGroupCreateView(**kwargs)[source]#

View that handles the creation of a new DataProductGroup.

model#: alias of DataProductGroup

class tom_dataproducts.views.DataProductGroupDataView(**kwargs)[source]#

View that handles the addition of DataProduct``s to a ``DataProductGroup. Requires authentication.

form_class#: alias of AddProductToGroupForm

form_valid(form)[source]#

Runs after form validation. Adds the specified DataProduct objects to the group.

Parameters:: form (AddProductToGroupForm) – Form with data products and group information

class tom_dataproducts.views.DataProductGroupDeleteView(**kwargs)[source]#

View that handles the deletion of a DataProductGroup. Requires authentication.

model#: alias of DataProductGroup

class tom_dataproducts.views.DataProductGroupDetailView(**kwargs)[source]#

View that handles the viewing of a specific DataProductGroup.

model#: alias of DataProductGroup

post(request, *args, **kwargs)[source]#: Handles the POST request for this view.

class tom_dataproducts.views.DataProductGroupListView(**kwargs)[source]#

View that handles the display of all DataProductGroup objects.

model#: alias of DataProductGroup

class tom_dataproducts.views.DataProductListView(**kwargs)[source]#

View that handles the list of DataProduct objects.

filterset_class#: alias of DataProductFilter

get_context_data(*args, **kwargs)[source]#

Adds the set of DataProductGroup objects to the context dictionary.

Returns:: context dictionary
Return type:: dict

get_queryset()[source]#

Gets the set of DataProduct objects that the user has permission to view.

Returns:: Set of DataProduct objects
Return type:: QuerySet

model#: alias of DataProduct

class tom_dataproducts.views.DataProductSaveView(**kwargs)[source]#

View that handles saving a DataProduct generated by an observation. Requires authentication.

post(request, *args, **kwargs)[source]#

Method that handles POST requests for the DataProductSaveView. Gets the observation facility that created the data and saves the selected data products as DataProduct objects. Redirects to the ObservationDetailView for the specific ObservationRecord.

Parameters:: request (HttpRequest) – Django POST request object

class tom_dataproducts.views.DataProductUploadView(**kwargs)[source]#

View that handles manual upload of DataProducts. Requires authentication.

form_class#: alias of DataProductUploadForm

form_invalid(form)[source]#: Adds errors to Django messaging framework in the case of an invalid form and redirects to the previous page.

form_valid(form)[source]#: Runs after DataProductUploadForm is validated. Saves each DataProduct and calls run_data_processor on each saved file. Redirects to the previous page.

get_form(*args, **kwargs)[source]#: Return an instance of the form to be used in this view.

class tom_dataproducts.views.DataShareView(**kwargs)[source]#

View that handles the sharing of data with another TOM.

form_class#: alias of DataShareForm

form_invalid(form)[source]#: Adds errors to Django messaging framework in the case of an invalid form and redirects to the previous page.

get_form(*args, **kwargs)[source]#: Return an instance of the form to be used in this view.

post(request, *args, **kwargs)[source]#: Method that handles the POST requests for sharing data. Handles Data Products and All the data of a type for a target as well as individual Reduced Datums. Share with TOM.

class tom_dataproducts.views.SingleTargetDataServiceQueryView(**kwargs)[source]#

View that handles queries for single target data services

get_context_data(

*args,

**kwargs,

)[source]#: Adds the target to the context object.

get_form_class()[source]#: Gets the single target data service form class

get_initial()[source]#: Populates the form with initial data including service name and target id

get_service()[source]#: Gets the single target data service that you want to query

get_service_class()[source]#: Gets the single target data service class

get_target()[source]#

Gets the target for observing from the database

Returns:: target for observing
Return type:: Target

get_target_id()[source]#: Parses the target id from the query parameters.

post(

request,

*args,

**kwargs,

)[source]#: Handle POST requests: instantiate a form instance with the passed POST variables and then check if it’s valid.

class tom_dataproducts.views.UpdateReducedDataView(**kwargs)[source]#

View that handles the updating of reduced data tied to a DataProduct that was ingested from a dataservice. The ReducedDatum.source must match the DataService.name Requires authentication.

get(request, *args, **kwargs)[source]#: Method that handles the GET requests for this view. Calls the management command to update the reduced data and adds a hint using the messages framework about automation.

get_redirect_url(*args, **kwargs)[source]#

Returns redirect URL as specified in the HTTP_REFERER field of the request.

Returns:: referer
Return type:: str