Search in sources :

Example 1 with GetAllNamedViews

use of uk.gov.gchq.gaffer.named.view.GetAllNamedViews in project gaffer-doc by gchq.

the class NamedViews method run.

@Override
public CloseableIterable<? extends Element> run() throws OperationException, IOException {
    // / [graph] create a graph using our schema and store properties
    // ---------------------------------------------------------
    final Graph graph = new Graph.Builder().config(getDefaultGraphConfig()).addSchemas(StreamUtil.openStreams(getClass(), schemaPath)).storeProperties(getDefaultStoreProperties()).build();
    // ---------------------------------------------------------
    // [user] Create a user
    // ---------------------------------------------------------
    final User user = new User("user01");
    // ---------------------------------------------------------
    // [add] Create a data generator and add the edges to the graph using an operation chain consisting of:
    // generateElements - generating edges from the data (note these are directed edges)
    // addElements - add the edges to the graph
    // ---------------------------------------------------------
    final OperationChain<Void> addOpChain = new OperationChain.Builder().first(new GenerateElements.Builder<String>().generator(new RoadAndRoadUseWithTimesAndCardinalitiesElementGenerator()).input(IOUtils.readLines(StreamUtil.openStream(getClass(), "RoadAndRoadUseWithTimesAndCardinalities/data.txt"))).build()).then(new AddElements()).build();
    graph.execute(addOpChain, user);
    // ---------------------------------------------------------
    // [add named view] add a NamedView to be reused
    // ---------------------------------------------------------
    final AddNamedView addNamedView = new AddNamedView.Builder().name("RoadUse edges").description("NamedView to get only RoadUse edges").view(new View.Builder().edge("RoadUse").build()).overwrite(false).build();
    // ---------------------------------------------------------
    printJsonAndPython("ADD_NAMED_VIEW", addNamedView);
    graph.execute(addNamedView, user);
    // [get all named views] Get all named views
    // ---------------------------------------------------------
    final GetAllNamedViews getAllNamedViews = new GetAllNamedViews();
    // ---------------------------------------------------------
    printJsonAndPython("GET_ALL_NAMED_VIEWS", new GetAllNamedViews());
    final CloseableIterable<NamedViewDetail> namedViewDetails = graph.execute(getAllNamedViews, user);
    for (final NamedViewDetail detail : namedViewDetails) {
        print("ALL_NAMED_VIEW", detail.toString());
    }
    // [get elements with named view] create the operation using the NamedView
    // ---------------------------------------------------------
    final GetElements operation = new GetElements.Builder().view(new NamedView.Builder().name("RoadUse edges").build()).input(new EntitySeed("10")).build();
    // ---------------------------------------------------------
    printJsonAndPython("GET_ELEMENTS_WITH_NAMED_VIEW", operation);
    final CloseableIterable<? extends Element> namedViewResults = graph.execute(operation, user);
    for (final Object result : namedViewResults) {
        print("GET_ELEMENTS_WITH_NAMED_VIEW_RESULTS", result.toString());
    }
    // [add named view with parameters] create an operation chain to be executed as a named operation
    // with parameters
    // ---------------------------------------------------------
    final String viewJson = "{" + "      \"edges\" : {" + "        \"RoadUse\" : {  " + "           \"preAggregationFilterFunctions\" : [ {" + "               \"predicate\" : {" + "                   \"class\" : \"uk.gov.gchq.koryphe.impl.predicate.IsMoreThan\"," + "                   \"orEqualTo\" : false," + "                     \"value\": {" + "                         \"java.lang.Long\" : \"${isMoreThan}\"" + "                       }" + "                 }," + "             \"selection\" : [ \"${property}\" ]" + "         } ] }" + "      }," + "      \"entities\" : { }" + "}";
    final ViewParameterDetail propertyParam = new ViewParameterDetail.Builder().description("Property to select").valueClass(String.class).required(true).build();
    final ViewParameterDetail valueParam = new ViewParameterDetail.Builder().description("Value for the is more than predicate").defaultValue(0L).valueClass(Long.class).build();
    final Map<String, ViewParameterDetail> paramDetailMap = Maps.newHashMap();
    paramDetailMap.put("property", propertyParam);
    paramDetailMap.put("isMoreThan", valueParam);
    final AddNamedView addNamedViewWithParams = new AddNamedView.Builder().name("customCountView").description("named View with count param").view(viewJson).parameters(paramDetailMap).overwrite(true).build();
    // ---------------------------------------------------------
    printJsonAndPython("ADD_NAMED_VIEW_WITH_PARAMETERS", addNamedViewWithParams);
    graph.execute(addNamedViewWithParams, user);
    // [get elements with named view with parameters] create the named operation with a parameter
    // ---------------------------------------------------------
    final Map<String, Object> paramMap = Maps.newHashMap();
    paramMap.put("property", "count");
    paramMap.put("isMoreThan", 1L);
    final GetElements operationUsingParams = new GetElements.Builder().view(new NamedView.Builder().name("customCountView").parameters(paramMap).build()).input(new EntitySeed("10")).build();
    // ---------------------------------------------------------
    printJsonAndPython("GET_ELEMENTS_WITH_NAMED_VIEW_WITH_PARAMETERS", operationUsingParams);
    final CloseableIterable<? extends Element> namedViewResultsWithParams = graph.execute(operationUsingParams, user);
    for (final Object result : namedViewResultsWithParams) {
        print("GET_ELEMENTS_WITH_NAMED_VIEW_WITH_PARAMETERS_RESULTS", result.toString());
    }
    return namedViewResultsWithParams;
}
Also used : AddElements(uk.gov.gchq.gaffer.operation.impl.add.AddElements) User(uk.gov.gchq.gaffer.user.User) GetElements(uk.gov.gchq.gaffer.operation.impl.get.GetElements) NamedViewDetail(uk.gov.gchq.gaffer.data.elementdefinition.view.NamedViewDetail) RoadAndRoadUseWithTimesAndCardinalitiesElementGenerator(uk.gov.gchq.gaffer.doc.user.generator.RoadAndRoadUseWithTimesAndCardinalitiesElementGenerator) ViewParameterDetail(uk.gov.gchq.gaffer.data.elementdefinition.view.ViewParameterDetail) NamedView(uk.gov.gchq.gaffer.data.elementdefinition.view.NamedView) AddNamedView(uk.gov.gchq.gaffer.named.view.AddNamedView) AddNamedView(uk.gov.gchq.gaffer.named.view.AddNamedView) GetAllNamedViews(uk.gov.gchq.gaffer.named.view.GetAllNamedViews) NamedView(uk.gov.gchq.gaffer.data.elementdefinition.view.NamedView) View(uk.gov.gchq.gaffer.data.elementdefinition.view.View) AddNamedView(uk.gov.gchq.gaffer.named.view.AddNamedView) Graph(uk.gov.gchq.gaffer.graph.Graph) OperationChain(uk.gov.gchq.gaffer.operation.OperationChain) EntitySeed(uk.gov.gchq.gaffer.operation.data.EntitySeed)

Example 2 with GetAllNamedViews

use of uk.gov.gchq.gaffer.named.view.GetAllNamedViews in project gaffer-doc by gchq.

the class GetAllNamedViewsExample method getAllNamedViews.

public void getAllNamedViews() {
    // ---------------------------------------------------------
    final GetAllNamedViews op = new GetAllNamedViews();
    // ---------------------------------------------------------
    showExample(op, null);
}
Also used : GetAllNamedViews(uk.gov.gchq.gaffer.named.view.GetAllNamedViews)

Example 3 with GetAllNamedViews

use of uk.gov.gchq.gaffer.named.view.GetAllNamedViews in project Gaffer by gchq.

the class GetAllNamedViewsHandlerTest method shouldGetAllAccessibleNamedViewsFromCache.

@Test
public void shouldGetAllAccessibleNamedViewsFromCache() throws OperationException {
    // Given
    initialiseCache();
    final NamedViewDetail namedViewAsDetail = new NamedViewDetail.Builder().name(testNamedViewName).view(view).creatorId(context.getUser().getUserId()).build();
    addNamedViewHandler.doOperation(addNamedView, context, store);
    final NamedViewDetail namedViewAsDetail2 = new NamedViewDetail.Builder().name(testNamedViewName + 2).view(view2).creatorId(context.getUser().getUserId()).build();
    addNamedViewHandler.doOperation(addNamedView2, context, store);
    addNamedViewHandler.doOperation(addNamedViewWithNoAccess, context, store);
    final GetAllNamedViews getAllNamedViews = new GetAllNamedViews.Builder().build();
    // when
    GetAllNamedViewsHandler getAllNamedViewsHandler = new GetAllNamedViewsHandler(namedViewCache);
    CloseableIterable<NamedViewDetail> namedViewList = getAllNamedViewsHandler.doOperation(getAllNamedViews, context, store);
    // Then
    assertEquals(2, Iterables.size(namedViewList));
    assertTrue(Iterables.contains(namedViewList, namedViewAsDetail));
    assertTrue(Iterables.contains(namedViewList, namedViewAsDetail2));
}
Also used : GetAllNamedViews(uk.gov.gchq.gaffer.named.view.GetAllNamedViews) NamedViewDetail(uk.gov.gchq.gaffer.data.elementdefinition.view.NamedViewDetail) Test(org.junit.jupiter.api.Test)

Aggregations

GetAllNamedViews (uk.gov.gchq.gaffer.named.view.GetAllNamedViews)3 NamedViewDetail (uk.gov.gchq.gaffer.data.elementdefinition.view.NamedViewDetail)2 Test (org.junit.jupiter.api.Test)1 NamedView (uk.gov.gchq.gaffer.data.elementdefinition.view.NamedView)1 View (uk.gov.gchq.gaffer.data.elementdefinition.view.View)1 ViewParameterDetail (uk.gov.gchq.gaffer.data.elementdefinition.view.ViewParameterDetail)1 RoadAndRoadUseWithTimesAndCardinalitiesElementGenerator (uk.gov.gchq.gaffer.doc.user.generator.RoadAndRoadUseWithTimesAndCardinalitiesElementGenerator)1 Graph (uk.gov.gchq.gaffer.graph.Graph)1 AddNamedView (uk.gov.gchq.gaffer.named.view.AddNamedView)1 OperationChain (uk.gov.gchq.gaffer.operation.OperationChain)1 EntitySeed (uk.gov.gchq.gaffer.operation.data.EntitySeed)1 AddElements (uk.gov.gchq.gaffer.operation.impl.add.AddElements)1 GetElements (uk.gov.gchq.gaffer.operation.impl.get.GetElements)1 User (uk.gov.gchq.gaffer.user.User)1