## Uses of Interface
org.modeshape.jcr.spi.federation.DocumentWriter

- Packages that use DocumentWriter
  Package | Description
  --- | ---
  org.modeshape.connector.git |
  org.modeshape.connector.meta.jdbc |
  org.modeshape.jcr.federation |
  org.modeshape.jcr.spi.federation | This package provides a Service Provider Interface (SPI) for connectors to external systems.

- - ### Uses of DocumentWriter in org.modeshape.connector.git

    Methods in org.modeshape.connector.git that return DocumentWriter
    Modifier and Type | Method and Description
    --- | ---
    `protected DocumentWriter` | GitConnector.`newDocumentWriter(String id)`

    Methods in org.modeshape.connector.git with parameters of type DocumentWriter
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | GitFunction.`addBranchesAsChildren(org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer)` Add the names of the branches as children of the current node.
    `protected void` | GitFunction.`addCommitsAsChildren(org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, int pageSize)` Add the first page of commits in the history names of the tags as children of the current node.
    `protected void` | GitTree.`addInformationForPath(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, DocumentWriter writer, org.eclipse.jgit.revwalk.RevCommit commit, String path, CallSpecification spec, Values values)`
    `protected void` | GitFunction.`addTagsAsChildren(org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer)` Add the names of the tags as children of the current node.
    `Document` | GitTree.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | GitTags.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | GitRoot.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | GitHistory.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `abstract Document` | GitFunction.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | GitCommitDetails.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`
    `Document` | GitBranches.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, DocumentWriter writer, Values values)`

  - ### Uses of DocumentWriter in org.modeshape.connector.meta.jdbc

    Methods in org.modeshape.connector.meta.jdbc with parameters of type DocumentWriter
    Modifier and Type | Method and Description
    --- | ---
    `protected Document` | TableRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | SchemaRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | ProcedureRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | ForeignKeyRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | DatabaseRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | ColumnRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected Document` | CatalogRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`
    `protected abstract Document` | AbstractMetadataRetriever.`getDocumentById(String id, DocumentWriter writer, Connection connection)`

  - ### Uses of DocumentWriter in org.modeshape.jcr.federation

    Classes in org.modeshape.jcr.federation that implement DocumentWriter
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FederatedDocumentWriter` Default implementation of the `DocumentWriter` interface.

    Methods in org.modeshape.jcr.federation that return DocumentWriter
    Modifier and Type | Method and Description
    --- | ---
    `DocumentWriter` | FederatedDocumentWriter.`addChild(String id, Name name)`
    `DocumentWriter` | FederatedDocumentWriter.`addChild(String id, String name)`
    `DocumentWriter` | FederatedDocumentWriter.`addMixinType(Name name)`
    `DocumentWriter` | FederatedDocumentWriter.`addMixinType(String name)`
    `DocumentWriter` | FederatedDocumentWriter.`addPage(String parentId, int nextPageOffset, long blockSize, long totalChildCount)`
    `DocumentWriter` | FederatedDocumentWriter.`addPage(String parentId, String nextPageOffset, long blockSize, long totalChildCount)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperties(Map<Name,Property> properties)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(Name name, Object value)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(Name name, Object[] values)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(Name name, Object firstValue, Object... additionalValues)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(String name, Object value)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(String name, Object[] values)`
    `DocumentWriter` | FederatedDocumentWriter.`addProperty(String name, Object firstValue, Object... additionalValues)`
    `DocumentWriter` | FederatedDocumentWriter.`addPropertyValue(Name name, Object value)`
    `DocumentWriter` | FederatedDocumentWriter.`addPropertyValue(String name, Object value)`
    `DocumentWriter` | FederatedDocumentWriter.`removeChild(String id)`
    `DocumentWriter` | FederatedDocumentWriter.`setCacheTtlSeconds(int seconds)`
    `DocumentWriter` | FederatedDocumentWriter.`setChildren(LinkedHashMap<String,Name> children)`
    `DocumentWriter` | FederatedDocumentWriter.`setChildren(List<? extends Document> children)`
    `DocumentWriter` | FederatedDocumentWriter.`setNotQueryable()`
    `DocumentWriter` | FederatedDocumentWriter.`setParent(String parentId)`
    `DocumentWriter` | FederatedDocumentWriter.`setParents(List<String> parentIds)`
    `DocumentWriter` | FederatedDocumentWriter.`setParents(String... parentIds)`
    `DocumentWriter` | FederatedDocumentWriter.`setPrimaryType(Name name)`
    `DocumentWriter` | FederatedDocumentWriter.`setPrimaryType(String name)`
    `DocumentWriter` | FederatedDocumentWriter.`setProperties(Map<Name,Property> properties)`
    `DocumentWriter` | FederatedDocumentWriter.`writeAdditionalDocument(String id)` Some connectors may want to pre-generate additional documents when `Connector.getDocumentById(String)` is called.

  - ### Uses of DocumentWriter in org.modeshape.jcr.spi.federation

    Methods in org.modeshape.jcr.spi.federation that return DocumentWriter
    Modifier and Type | Method and Description
    --- | ---
    `DocumentWriter` | DocumentWriter.`addChild(String id, Name name)`
    `DocumentWriter` | DocumentWriter.`addChild(String id, String name)`
    `DocumentWriter` | DocumentWriter.`addMixinType(Name name)` Adds a mixin type to the underlying document.
    `DocumentWriter` | DocumentWriter.`addMixinType(String name)` Adds a mixin type to the underlying document.
    `DocumentWriter` | DocumentWriter.`addPage(String parentId, int nextPageOffset, long blockSize, long totalChildCount)`
    `DocumentWriter` | DocumentWriter.`addPage(String parentId, String nextPageOffset, long blockSize, long totalChildCount)`
    `DocumentWriter` | DocumentWriter.`addProperties(Map<Name,Property> properties)` Adds a map of properties to the the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(Name name, Object value)` Adds a property with the given name and value to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(Name name, Object[] values)` Adds a multi-value property with the given name to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(Name name, Object firstValue, Object... additionalValues)` Adds a multi-value property with the given name to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(String name, Object value)` Adds a property with the given name and value to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(String name, Object[] values)` Adds a multi-value property with the given name to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addProperty(String name, Object firstValue, Object... additionalValues)` Adds a multi-value property with the given name to the underlying document's properties.
    `DocumentWriter` | DocumentWriter.`addPropertyValue(Name name, Object value)` Adds an additional value to an existing property with the given name.
    `DocumentWriter` | DocumentWriter.`addPropertyValue(String name, Object value)` Adds an additional value to an existing property with the given name.
    `protected DocumentWriter` | Connector.`newDocument(String id)` Obtain a new `DocumentWriter` that can be used to construct a document, typically within the `Connector.getDocumentById(String)` method.
    `DocumentWriter` | DocumentWriter.`removeChild(String id)`
    `DocumentWriter` | DocumentWriter.`setCacheTtlSeconds(int seconds)` Sets the value, in seconds, of the amount of the time the underlying document should be cached.
    `DocumentWriter` | DocumentWriter.`setChildren(LinkedHashMap<String,Name> children)`
    `DocumentWriter` | DocumentWriter.`setChildren(List<? extends Document> children)`
    `DocumentWriter` | DocumentWriter.`setId(String id)` Sets an identifier string on the underlying document.
    `DocumentWriter` | DocumentWriter.`setNotQueryable()` Sets a flag on the underlying document which indicates that it should not be indexed (and therefore will not appear in queries) by the repository.
    `DocumentWriter` | DocumentWriter.`setParent(String parentId)` Sets the id of the parent of the underlying document.
    `DocumentWriter` | DocumentWriter.`setParents(List<String> parentIds)` Sets the ids of one or more parents on the underlying document.
    `DocumentWriter` | DocumentWriter.`setParents(String... parentIds)` Sets the ids of one or more parents on the underlying document.
    `DocumentWriter` | DocumentWriter.`setPrimaryType(Name name)` Sets the primary type of the underlying document.
    `DocumentWriter` | DocumentWriter.`setPrimaryType(String name)` Sets the primary type of the underlying document.
    `DocumentWriter` | DocumentWriter.`setProperties(Map<Name,Property> properties)` Replaces the underlying document's properties with the one from the given map.
    `DocumentWriter` | DocumentWriter.`writeAdditionalDocument(String id)` Some connectors may want to pre-generate additional documents when `Connector.getDocumentById(String)` is called.
    `protected DocumentWriter` | Connector.`writeDocument(Document document)` Obtain a new `DocumentWriter` that can be used to update a document.

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.