diff --git a/README.md b/README.md index 3fbc56335e7..2aedb498495 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Gaffer offers: - Retrieval of graph data into Apache Spark for fast and flexible analysis; - A fully-featured REST API. -To get going with Gaffer, visit our [getting started pages](https://gchq.github.io/gaffer-doc/summaries/getting-started.html). +To get going with Gaffer, visit our [getting started pages](https://gchq.github.io/gaffer-doc/v1docs/summaries/getting-started.html). Gaffer is under active development. Version 1.0 of Gaffer was released in October 2017. @@ -54,7 +54,7 @@ We have a demo available to try that is based around a small uk road use dataset To build Gaffer run `mvn clean install -Pquick` in the top-level directory. This will build all of Gaffer's core libraries and some examples of how to load and query data. -See our [Store](https://gchq.github.io/gaffer-doc/summaries/stores.html) documentation page for a list of available Gaffer Stores to chose from and the relevant documentation for each. +See our [Store](https://gchq.github.io/gaffer-doc/v1docs/summaries/stores.html) documentation page for a list of available Gaffer Stores to chose from and the relevant documentation for each. ### Inclusion in other projects @@ -81,7 +81,7 @@ This will include all other mandatory dependencies. Other (optional) components Our Javadoc can be found [here](http://gchq.github.io/Gaffer/). -We have some user guides in our [docs](https://gchq.github.io/gaffer-doc/getting-started/user-guide/contents.html). +We have some user guides in our [docs](https://gchq.github.io/gaffer-doc/v1docs/getting-started/user-guide/contents.html). Related repositories -------------------- @@ -100,7 +100,7 @@ The [gaffer-tools](https://github.com/gchq/gaffer-tools) repository contains use Contributing ------------ -We welcome contributions to the project. Detailed information on our ways of working can be found [here](https://gchq.github.io/gaffer-doc/other/ways-of-working.html). In brief: +We welcome contributions to the project. Detailed information on our ways of working can be found [here](https://gchq.github.io/gaffer-doc/v1docs/other/ways-of-working.html). In brief: - Sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/Gaffer); - Push your changes to a fork; diff --git a/core/graph/README.md b/core/graph/README.md index d34b0e82333..33651627e19 100644 --- a/core/graph/README.md +++ b/core/graph/README.md @@ -38,11 +38,11 @@ store properties, a schema and some graph specific configuration. ## Store Properties The store properties tells the graph the type of store to connect to -along with any required connection details. See [Stores](https://gchq.github.io/gaffer-doc/summaries/stores.html) for more information on the different Stores for Gaffer. +along with any required connection details. See [Stores](https://gchq.github.io/gaffer-doc/v1docs/summaries/stores.html) for more information on the different Stores for Gaffer. ## Schema The schema is passed to the store to instruct the store how to store -and process the data. See [Schemas](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/schemas.html) for more information. +and process the data. See [Schemas](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/schemas.html) for more information. ## Graph Configuration The graph configuration allows you to apply special customisations to the Graph instance. diff --git a/core/operation/README.md b/core/operation/README.md index 9daec5e46a3..5b3e747ba24 100644 --- a/core/operation/README.md +++ b/core/operation/README.md @@ -117,7 +117,7 @@ For use with a `ScoreOperationChain`, some `Operation`s may require a custom way of calculating an associated score, therefore an implementation of the `ScoreResolver` interface may be required. There is a `DefaultScoreResolver` to which the custom implementation should delegate, in a manner specific to the -new Operation. For more info, see [ScoreOperationChain](https://gchq.github.io/gaffer-doc/components/core/store.html#scoreoperationchain) and [ScoreOperationChainExample](https://gchq.github.io/gaffer-doc/getting-started/operations/scoreoperationchain.html). +new Operation. For more info, see [ScoreOperationChain](https://gchq.github.io/gaffer-doc/v1docs/components/core/store.html#scoreoperationchain) and [ScoreOperationChainExample](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/scoreoperationchain.html). #### Documentation @@ -131,7 +131,7 @@ and simple usage examples in [Gaffer-doc](https://github.com/gchq/gaffer-doc). Alongside documentation, if the new `Operation` is to be integrated into Gaffer, it is good practice to add it into the Python-Shell of [Gaffer-tools](https://github.com/gchq/gaffer-tools). -For more information, see the [introduction to the Python Shell](https://gchq.github.io/gaffer-doc/components/tool/python-shell.html). +For more information, see the [introduction to the Python Shell](https://gchq.github.io/gaffer-doc/v1docs/components/tool/python-shell.html). ## Lazy Results Operation results are lazy (where possible) so that results are lazily @@ -195,7 +195,7 @@ You need to provide a View to override the groupBy fields for all the element gr #### My queries are returning duplicate results - why and how can I deduplicate them? For example, if you have a Graph containing the Edge A-B and you do a GetElements with a large number of seeds, with the first seed A and the last seed B, then you will get the Edge A-B back twice. This is because Gaffer stores lazily return the results for your query to avoid loading all the results into memory so it will not realise the A-B has been queried for twice. -You can deduplicate your results in memory using the [ToSet](https://gchq.github.io/gaffer-doc/getting-started/operations/toset.html) operation. But, be careful to only use this when you have a small number of results. It might be worth also using the [Limit](https://gchq.github.io/gaffer-doc/getting-started/operation-examples.html#limit-example) operation prior to ToSet to ensure you don't run out of memory. +You can deduplicate your results in memory using the [ToSet](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/toset.html) operation. But, be careful to only use this when you have a small number of results. It might be worth also using the [Limit](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operation-examples.html#limit-example) operation prior to ToSet to ensure you don't run out of memory. e.g: @@ -355,7 +355,7 @@ points for your AddElementsFromHdfs operation. #### I want to filter the results of my query based on the destination of the result Edges OK, there are several ways of doing this and you will need to chose the most appropriate -way for your needs. Also worth reading [GetElements example](https://gchq.github.io/gaffer-doc/getting-started/operations/getelements.html). +way for your needs. Also worth reading [GetElements example](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/getelements.html). If you are querying with just a single EntitySeed with a vertex value of X and require the destination to be Y then you should change your query to use an EdgeSeed @@ -366,7 +366,7 @@ EdgeSeed as described above. If you require your destination to match a provided regex than you will need to use the regex filter: uk.gov.gchq.koryphe.impl.predicate.Regex or uk.gov.gchq.koryphe.impl.predicate.MultiRegex. -See the [Predicate examples](https://gchq.github.io/gaffer-doc/getting-started/predicates/contents.html). +See the [Predicate examples](https://gchq.github.io/gaffer-doc/v1docs/getting-started/predicates/contents.html). The predicate can then be used in you Operation View to filter out elements that don't match the regex. @@ -420,4 +420,4 @@ GetElements results = new GetElements.Builder() .build(); ``` -For more information on filtering see: [Filtering](https://gchq.github.io/gaffer-doc/getting-started/user-guide/filtering.html). +For more information on filtering see: [Filtering](https://gchq.github.io/gaffer-doc/v1docs/getting-started/user-guide/filtering.html). diff --git a/core/store/src/main/java/uk/gov/gchq/gaffer/store/schema/SchemaOptimiser.java b/core/store/src/main/java/uk/gov/gchq/gaffer/store/schema/SchemaOptimiser.java index 7fddd9fbb77..6671d773bd2 100644 --- a/core/store/src/main/java/uk/gov/gchq/gaffer/store/schema/SchemaOptimiser.java +++ b/core/store/src/main/java/uk/gov/gchq/gaffer/store/schema/SchemaOptimiser.java @@ -122,7 +122,7 @@ private void addDefaultSerialisers(final Schema schema, final Map