## Uses of Interface
org.infinispan.schematic.document.EditableDocument

- Packages that use EditableDocument
  Package | Description
  --- | ---
  org.infinispan.schematic |
  org.infinispan.schematic.document |
  org.infinispan.schematic.internal |
  org.infinispan.schematic.internal.document |
  org.modeshape.jboss.service |
  org.modeshape.jboss.subsystem |
  org.modeshape.jcr.cache.document |
  org.modeshape.jcr.federation |
  org.modeshape.jcr.spi.federation | This package provides a Service Provider Interface (SPI) for connectors to external systems.

- - ### Uses of EditableDocument in org.infinispan.schematic

    Classes in org.infinispan.schematic that implement EditableDocument
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `Schematic.EditorImpl`

    Methods in org.infinispan.schematic that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | SchematicEntry.`editDocumentContent()` Get an `editable document`, when the content is a `document`.
    `EditableDocument` | SchematicEntry.`editMetadata()` Get an `editable metadata document`.
    `static EditableDocument` | DocumentFactory.`newDocument()` Create a new editable document that can be used as a new document entry in a SchematicDb or as nested documents for other documents.
    `static EditableDocument` | DocumentFactory.`newDocument(Document original)` Create a new editable document that is a copy of the supplied document.
    `static EditableDocument` | DocumentFactory.`newDocument(String name, Object value)` Create a new editable document, initialized with a single field, that can be used as a new document entry in a SchematicDb or as nested documents for other documents.
    `static EditableDocument` | DocumentFactory.`newDocument(String name1, Object value1, String name2, Object value2)` Create a new editable document, initialized with two fields, that can be used as a new document entry in a SchematicDb or as nested documents for other documents.
    `static EditableDocument` | DocumentFactory.`newDocument(String name1, Object value1, String name2, Object value2, String name3, Object value3)` Create a new editable document, initialized with three fields, that can be used as a new document entry in a SchematicDb or as nested documents for other documents.
    `static EditableDocument` | DocumentFactory.`newDocument(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)` Create a new editable document, initialized with four fields, that can be used as a new document entry in a SchematicDb or as nested documents for other documents.

  - ### Uses of EditableDocument in org.infinispan.schematic.document

    Subinterfaces of EditableDocument in org.infinispan.schematic.document
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `EditableArray`
    `interface` | `Editor`

    Methods in org.infinispan.schematic.document that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | EditableArray.`addCode(int index, String code, boolean includeScope)` Insert the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableArray.`addCode(int index, String code, Document scope)` Insert the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableArray.`addCode(String code, boolean includeScope)` Adds to this array a `Code` with the supplied JavaScript code.
    `EditableDocument` | EditableArray.`addCode(String code, Document scope)` Adds to this array a `CodeWithScope` with the supplied JavaScript code and scope.
    `EditableDocument` | EditableArray.`addCodeIfAbsent(String code, Document scope)` Adds to this array a `CodeWithScope` with the supplied JavaScript code and scope, if and only if an equivalent value doesn't already exist in the array.
    `EditableDocument` | EditableArray.`addDocument()` Adds to this array a new empty document.
    `EditableDocument` | EditableArray.`addDocument(Document document)` Adds to this array the supplied document.
    `EditableDocument` | EditableArray.`addDocument(int index)` Insert the value for the field at the given index to be a new, empty Document.
    `EditableDocument` | EditableArray.`addDocument(int index, Document document)` Insert the value for the field at the given index to be the supplied Document.
    `EditableDocument` | EditableArray.`addDocumentIfAbsent(Document document)` Adds to this array the supplied document, if and only if an equivalent value doesn't already exist in the array.
    `EditableDocument` | EditableArray.`addValueIfAbsent(Object value)` Add the supplied value to this array if and only if there is not already an equivalent value in the array.
    `EditableDocument` | EditableDocument.`getDocument(String name)` Get the existing document value in this document for the given field name.
    `EditableDocument` | EditableArray.`getDocument(String name)` Get the existing document value in this array for the given index.
    `EditableDocument` | EditableDocument.`getOrCreateDocument(String name)` Get the existing document value in this document for the given field name, or create a new document if there is no existing document at this field.
    `EditableDocument` | EditableDocument.`set(String name, Object value)` Set the value for the field with the given name to the supplied value.
    `EditableDocument` | EditableDocument.`setBinary(String name, byte type, byte[] data)` Set the value for the field with the given name to be a binary value.
    `EditableDocument` | EditableDocument.`setBoolean(String name, boolean value)` Set the value for the field with the given name to the supplied boolean value.
    `EditableDocument` | EditableArray.`setCode(int index, String code, boolean includeScope)` Set the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableArray.`setCode(int index, String code, Document scope)` Set the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableDocument.`setCode(String name, String code, boolean includeScope)` Set the value for the field with the given name to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableArray.`setCode(String name, String code, boolean includeScope)` Set the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableDocument.`setCode(String name, String code, Document scope)` Set the value for the field with the given name to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableArray.`setCode(String name, String code, Document scope)` Set the value for the field at the given index to be a `Code` or `CodeWithScope`.
    `EditableDocument` | EditableDocument.`setDate(String name, Date value)` Set the value for the field with the given name to the supplied date value.
    `EditableDocument` | EditableDocument.`setDate(String name, String isoDate)` Set the value for the field with the given name to the date value parsed from the ISO-8601 date representation.
    `EditableDocument` | EditableArray.`setDocument(int index)` Set the value for the field at the given index to be a new, empty Document.
    `EditableDocument` | EditableArray.`setDocument(int index, Document document)` Set the value for the field at the given index to be the supplied Document.
    `EditableDocument` | EditableDocument.`setDocument(String name)` Set the value for the field with the given name to be a new, empty Document.
    `EditableDocument` | EditableArray.`setDocument(String name)` Set the value for the field at the given index to be a new, empty Document.
    `EditableDocument` | EditableDocument.`setDocument(String name, Document document)` Set the value for the field with the given name to be the supplied Document.
    `EditableDocument` | EditableArray.`setDocument(String name, Document document)` Set the value for the field at the given index to be the supplied Document.
    `EditableDocument` | EditableDocument.`setNull(String name)` Set the value for the field with the given name to be a null value.
    `EditableDocument` | EditableDocument.`setNumber(String name, double value)` Set the value for the field with the given name to the supplied double value.
    `EditableDocument` | EditableDocument.`setNumber(String name, float value)` Set the value for the field with the given name to the supplied float value.
    `EditableDocument` | EditableDocument.`setNumber(String name, int value)` Set the value for the field with the given name to the supplied integer value.
    `EditableDocument` | EditableDocument.`setNumber(String name, long value)` Set the value for the field with the given name to the supplied long value.
    `EditableDocument` | EditableDocument.`setObjectId(String name, byte[] bytes)` Set the value for the field with the given name to an `ObjectId` created from the supplied 12-byte binary value.
    `EditableDocument` | EditableDocument.`setObjectId(String name, int time, int machine, int process, int inc)` Set the value for the field with the given name to an `ObjectId` created from the supplied hexadecimal binary value.
    `EditableDocument` | EditableDocument.`setObjectId(String name, String hex)` Set the value for the field with the given name to an `ObjectId` created from the supplied hexadecimal binary value.
    `EditableDocument` | EditableDocument.`setRegularExpression(String name, String pattern)` Set the value for the field with the given name to the supplied regular expression.
    `EditableDocument` | EditableDocument.`setRegularExpression(String name, String pattern, int flags)` Set the value for the field with the given name to the supplied regular expression.
    `EditableDocument` | EditableDocument.`setString(String name, String value)` Set the value for the field with the given name to the supplied string value.
    `EditableDocument` | EditableDocument.`setSymbol(String name, String value)` Set the value for the field with the given name to a `Symbol` created from the supplied string value.
    `EditableDocument` | EditableDocument.`setTimestamp(String name, int timeInSeconds, int increment)` Set the value for the field with the given name to a `Timestamp` with the supplied time in seconds and increment.
    `EditableDocument` | EditableDocument.`setUuid(String name, UUID uuid)` Set the value for the field with the given name to be a `UUID`.

  - ### Uses of EditableDocument in org.infinispan.schematic.internal

    Methods in org.infinispan.schematic.internal that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | SchematicEntryProxy.`editDocumentContent()`
    `EditableDocument` | SchematicEntryLiteral.`editDocumentContent()`
    `EditableDocument` | ImmutableSchematicValue.`editDocumentContent()`
    `EditableDocument` | SchematicEntryProxy.`editMetadata()`
    `EditableDocument` | SchematicEntryLiteral.`editMetadata()`
    `EditableDocument` | ImmutableSchematicValue.`editMetadata()`
    `protected EditableDocument` | SchematicEntryProxy.`editorFor(Document doc, Path pathToDocument, DocumentObserver observer)`

  - ### Uses of EditableDocument in org.infinispan.schematic.internal.document

    Classes in org.infinispan.schematic.internal.document that implement EditableDocument
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ArrayEditor`
    `class` | `DocumentEditor`
    `class` | `ObservableArrayEditor`
    `class` | `ObservableDocumentEditor`

    Methods in org.infinispan.schematic.internal.document that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | ArrayEditor.`addCode(int index, String code, boolean includeScope)`
    `EditableDocument` | ArrayEditor.`addCode(int index, String code, Document scope)`
    `EditableDocument` | ArrayEditor.`addCode(String code, boolean includeScope)`
    `EditableDocument` | ArrayEditor.`addCode(String code, Document scope)`
    `EditableDocument` | ArrayEditor.`addCodeIfAbsent(String code, Document scope)`
    `EditableDocument` | ArrayEditor.`addDocument()`
    `EditableDocument` | ArrayEditor.`addDocument(Document document)`
    `EditableDocument` | ArrayEditor.`addDocument(int index)`
    `EditableDocument` | ArrayEditor.`addDocument(int index, Document document)`
    `EditableDocument` | ArrayEditor.`addDocumentIfAbsent(Document document)`
    `protected EditableDocument` | ObservableArrayEditor.`createEditableDocument(MutableDocument document, int index, DocumentValueFactory factory)`
    `protected EditableDocument` | ArrayEditor.`createEditableDocument(MutableDocument document, int index, DocumentValueFactory factory)`
    `protected EditableDocument` | ObservableDocumentEditor.`createEditableDocument(MutableDocument document, String fieldName, DocumentValueFactory factory)`
    `protected EditableDocument` | DocumentEditor.`createEditableDocument(MutableDocument document, String fieldName, DocumentValueFactory factory)`
    `protected EditableDocument` | ArrayEditor.`editable(Document doc, int index)`
    `protected EditableDocument` | DocumentEditor.`editable(Document doc, String fieldName)`
    `EditableDocument` | DocumentEditor.`getDocument(String name)`
    `EditableDocument` | ArrayEditor.`getDocument(String name)`
    `EditableDocument` | DocumentEditor.`getOrCreateDocument(String name)`
    `EditableDocument` | ArrayEditor.`getOrCreateDocument(String name)`
    `EditableDocument` | DocumentEditor.`set(String name, Object value)`
    `EditableDocument` | DocumentEditor.`setBinary(String name, byte type, byte[] data)`
    `EditableDocument` | DocumentEditor.`setBoolean(String name, boolean value)`
    `EditableDocument` | ArrayEditor.`setCode(int index, String code, boolean includeScope)`
    `EditableDocument` | ArrayEditor.`setCode(int index, String code, Document scope)`
    `EditableDocument` | DocumentEditor.`setCode(String name, String code, boolean includeScope)`
    `EditableDocument` | ArrayEditor.`setCode(String name, String code, boolean includeScope)`
    `EditableDocument` | DocumentEditor.`setCode(String name, String code, Document scope)`
    `EditableDocument` | ArrayEditor.`setCode(String name, String code, Document scope)`
    `EditableDocument` | DocumentEditor.`setDate(String name, Date value)`
    `EditableDocument` | DocumentEditor.`setDate(String name, String isoDate)`
    `EditableDocument` | ArrayEditor.`setDocument(int index)`
    `EditableDocument` | ArrayEditor.`setDocument(int index, Document document)`
    `EditableDocument` | DocumentEditor.`setDocument(String name)`
    `EditableDocument` | ArrayEditor.`setDocument(String name)`
    `EditableDocument` | DocumentEditor.`setDocument(String name, Document document)`
    `EditableDocument` | ArrayEditor.`setDocument(String name, Document document)`
    `EditableDocument` | DocumentEditor.`setNull(String name)`
    `EditableDocument` | DocumentEditor.`setNumber(String name, double value)`
    `EditableDocument` | DocumentEditor.`setNumber(String name, float value)`
    `EditableDocument` | DocumentEditor.`setNumber(String name, int value)`
    `EditableDocument` | DocumentEditor.`setNumber(String name, long value)`
    `EditableDocument` | DocumentEditor.`setObjectId(String name, byte[] bytes)`
    `EditableDocument` | DocumentEditor.`setObjectId(String name, int time, int machine, int process, int inc)`
    `EditableDocument` | DocumentEditor.`setObjectId(String name, String hex)`
    `EditableDocument` | DocumentEditor.`setRegularExpression(String name, String pattern)`
    `EditableDocument` | DocumentEditor.`setRegularExpression(String name, String pattern, int flags)`
    `EditableDocument` | DocumentEditor.`setString(String name, String value)`
    `EditableDocument` | DocumentEditor.`setSymbol(String name, String value)`
    `EditableDocument` | DocumentEditor.`setTimestamp(String name, int timeInSeconds, int increment)`
    `EditableDocument` | DocumentEditor.`setUuid(String name, UUID uuid)`

  - ### Uses of EditableDocument in org.modeshape.jboss.service

    Constructors in org.modeshape.jboss.service with parameters of type EditableDocument
    Constructor and Description
    `BinaryStorageService(String repositoryName, EditableDocument binaryConfig)`
    `CompositeBinaryStorageService(String repositoryName, EditableDocument binaries)`

  - ### Uses of EditableDocument in org.modeshape.jboss.subsystem

    Methods in org.modeshape.jboss.subsystem with parameters of type EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | AddCompositeBinaryStorage.`createBinaryStorageService(org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, List<org.jboss.msc.service.ServiceController<?>> newControllers, org.jboss.msc.service.ServiceTarget target, String repositoryName, EditableDocument binaries, org.jboss.msc.service.ServiceName serviceName)`
    `protected void` | AbstractAddBinaryStorage.`createBinaryStorageService(org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, List<org.jboss.msc.service.ServiceController<?>> newControllers, org.jboss.msc.service.ServiceTarget target, String repositoryName, EditableDocument binaries, org.jboss.msc.service.ServiceName serviceName)`
    `protected void` | AddFileBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`
    `protected void` | AddDatabaseBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`
    `protected void` | AddCustomBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`
    `protected void` | AddCompositeBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`
    `protected void` | AddCacheBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`
    `protected abstract void` | AbstractAddBinaryStorage.`writeBinaryStorageConfiguration(String repositoryName, org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode storage, EditableDocument binaryStorage)`
    `protected void` | AbstractAddBinaryStorage.`writeCommonBinaryStorageConfiguration(org.jboss.as.controller.OperationContext context, org.jboss.dmr.ModelNode model, EditableDocument binaries)`

  - ### Uses of EditableDocument in org.modeshape.jcr.cache.document

    Methods in org.modeshape.jcr.cache.document that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | DocumentTranslator.`fromChildReference(ChildReference ref)`

    Methods in org.modeshape.jcr.cache.document with parameters of type EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | DocumentTranslator.`addFederatedSegment(EditableDocument document, String externalNodeKey, String name)`
    `void` | DocumentTranslator.`addPropertyValues(EditableDocument document, Name propertyName, boolean isMultiple, Collection<?> values, Set<BinaryKey> unusedBinaryKeys)`
    `void` | DocumentTranslator.`changeChildren(EditableDocument document, SessionNode.ChangedChildren changedChildren, ChildReferences appended)`
    `void` | DocumentTranslator.`changeReferrers(EditableDocument document, SessionNode.ReferrerChanges changes)`
    `abstract boolean` | LocalDocumentStore.DocumentOperation.`execute(String key, EditableDocument document)` Execute the operation upon the given `EditableDocument`.
    `protected long` | DocumentTranslator.`insertChildren(EditableDocument document, Map<NodeKey,SessionNode.Insertions> insertionsByBeforeKey, Set<NodeKey> removals, Map<NodeKey,Name> newNames)`
    `boolean` | DocumentTranslator.`isLocked(EditableDocument doc)` Checks if the given document is already locked
    `protected String` | DocumentOptimizer.`mergeChildren(NodeKey key, EditableDocument document, EditableArray children, boolean isFirst, String nextBlock)` Modify the supplied document (with the given key) to merge in all of the children from the next block.
    `boolean` | DocumentOptimizer.`optimizeChildrenBlocks(NodeKey key, EditableDocument document, int targetCountPerBlock, int tolerance)` Optimize the children in the supplied node document Note that this method changes the underlying db as well as the given document, so *it must* be called either from a transactional context or it must be followed by a session.save call, otherwise there might be inconsistencies between what a session sees as "persisted" state and the reality.
    `protected void` | DocumentTranslator.`removeFederatedSegments(EditableDocument federatedDocument, Set<String> externalNodeKeys)`
    `Property` | DocumentTranslator.`removeProperty(EditableDocument document, Name propertyName, Set<BinaryKey> unusedBinaryKeys)`
    `void` | DocumentTranslator.`removePropertyValues(EditableDocument document, Name propertyName, Collection<?> values, Set<BinaryKey> unusedBinaryKeys)`
    `void` | DocumentTranslator.`setKey(EditableDocument document, NodeKey key)`
    `void` | DocumentTranslator.`setKey(EditableDocument document, String key)`
    `void` | DocumentTranslator.`setParents(EditableDocument document, NodeKey parent, NodeKey oldParent, SessionNode.ChangedAdditionalParents additionalParents)`
    `void` | DocumentTranslator.`setProperty(EditableDocument document, Property property, Set<BinaryKey> unusedBinaryKeys)`
    `void` | DocumentTranslator.`setQueryable(EditableDocument document, boolean queryable)` Marks the given document as queryable, by setting a flag.
    `protected boolean` | DocumentOptimizer.`splitChildren(NodeKey key, EditableDocument document, EditableArray children, int targetCountPerBlock, int tolerance, boolean isFirst, String nextBlock)` Split the children in the given document (with the given key) into two or more blocks, based upon the specified number of desired children per block and a tolerance.

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

    Methods in org.modeshape.jcr.federation that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | FederatedDocumentWriter.`document()`
    `EditableDocument` | FederatedSchematicEntry.`editDocumentContent()`
    `EditableDocument` | FederatedSchematicEntry.`editMetadata()`

    Constructors in org.modeshape.jcr.federation with parameters of type EditableDocument
    Constructor and Description
    `FederatedSchematicEntry(EditableDocument document)`

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

    Methods in org.modeshape.jcr.spi.federation that return EditableDocument
    Modifier and Type | Method and Description
    --- | ---
    `EditableDocument` | PageWriter.`document()` Returns the underlying document.

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