Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

# ModeShape Distribution Public API Reference (2.8.2.Final)

JCR engine
org.modeshape.jcr | The ModeShape implementation of the JCR API.
org.modeshape.jcr.api | This package provides a set of interfaces that extend the JCR 2.0 API interfaces with additional functionality, as well as defining the `Repositories` interface as a generic abstraction to any container of multiple JCR `Repository` instances.
org.modeshape.jcr.api.nodetype |
org.modeshape.jcr.api.query | This package provides a set of interfaces that extend the JCR 2.0 API query interfaces with JCR 2.0 functionality.
org.modeshape.jcr.api.query.qom |
org.modeshape.jcr.nodetype | The ModeShape specification for programmatically creating JCR `NodeDefinition`s.

Graph API
org.modeshape.graph | The ModeShape Graph API defines the types that allow you to work with content organized as a graph.
org.modeshape.graph.io | Utilities for inputing and outputing larger amounts of data.
org.modeshape.graph.observe | The Observation API provides several mechanisms for asynchronously observing changes to content.
org.modeshape.graph.property | Nodes in a graph contain properties, and this package defines the interfaces, classes and exceptions for representing and working with properties and their values.
org.modeshape.graph.request | Sometimes its useful to work with a graph using objects that represent individual commands on the graph.
org.modeshape.graph.request.function | The `Function` interface provides a way to inject custom logic into a connector, where it can be executed close to the actual data and where it can make decisions about what changes should be made to the content.
org.modeshape.graph.request.processor | This portion of the ModeShape Graph API defines the `processor` for `requests`.
org.modeshape.graph.session | A graph session provides a stateful environment in which graph operations can be enqueued and the state and structure of the graph are cached.
org.modeshape.graph.xml | Graph content can often be represented in XML, so this part of the ModeShape Graph API defines the classes that provide the binding between graph and XML content.

Query and Search
org.modeshape.graph.query | The Query API provides a mechanism for building and executing queries.
org.modeshape.graph.query.model | The Abstract Query Model is a vocabulary that can be used to construct a language-neutral representation of a query.
org.modeshape.graph.query.optimize | This package contains the Optimizer interface, a rule-based optimizer implementation, and library of optimization rules.
org.modeshape.graph.query.parse | This package defines the `QueryParser` interface, which defines a component that can parse a query represented in a specific language and produce the corresponding `abstract query model` representation.
org.modeshape.graph.query.plan | This package defines the `Planner` interface, the `CanonicalPlanner` implementation, and the `PlanNode` class that is used to represent a canonical query plan.
org.modeshape.graph.query.process | This package defines the `QueryProcessor` interface, which is responsible for constructing for each query a tree of `ProcessingComponent` objects that each are responsible for processing a specific aspect of the query and returning the tuples to the parent component.
org.modeshape.graph.query.validate | This package provides the interfaces that define the tables and columns that can be queried.
org.modeshape.graph.search | A small framework for a search engine component.

Connector SPI
org.modeshape.graph.cache | Caching of graph content is controlled with `cache policies`, and these are used in `connectors` and in `requests` (among other places).
org.modeshape.graph.connector | ModeShape uses connectors to access information from external systems (such as databases, other repositories, services, applications, etc.) and create graph representations of that information.
org.modeshape.graph.connector.base | This package defines a series of classes that can serve as base classes for a connector implementation.
org.modeshape.graph.connector.base.cache |
org.modeshape.graph.connector.map | The `MapRepository` class and its supporting classes provide a default implementation of the connector classes for connectors that support the transient or persistent mapping of a UUID to a `standard representation of a node`.
org.modeshape.graph.connector.path | The `PathRepository` class and its supporting classes provide a default read-only implementation of the connector classes for connectors that only support path-based access to a `standard representation of a node`.
org.modeshape.graph.connector.path.cache | The `PathRepositoryCache` class and its supporting classes provide a standard caching mechanism for path-based repositories.
org.modeshape.graph.connector.xmlfile | The XML File connector is a `connector` that maintains a graph in transient in-process memory, where the graph is loaded initially from an XML file.

Sequencer SPI
org.modeshape.graph.sequencer | A sequencer in ModeShape is a component that is able to process information (usually the content of a file, or a property value on a node) and recreate that information as a graph of structured content.

MIME type detector SPI
org.modeshape.graph.mimetype | This package defines an interface for the `MIME type detector`, which represents a component that is able to determine the MIME type for a stream of data and/or the name of the file containing the data.

Text extractor SPI
org.modeshape.graph.text | This package defines an interface for components that `extract text` from content.

Connectors
org.modeshape.connector.disk | The classes that make up the connector that stores content in a ModeShape-specific format on fixed disk.
org.modeshape.connector.filesystem | The classes that make up the connector that accesses the files and directories on a local file system and exposes them as content in a repository.
org.modeshape.connector.infinispan | The classes that make up the connector that stores content in a deployed instance of Infinispan.
org.modeshape.connector.jbosscache | The classes that make up the connector that stores content in a JBoss Cache instance.
org.modeshape.connector.jcr | The JCR connector provides access to a JCR repository instance running in the same process (and accessible via JNDI).
org.modeshape.connector.meta.jdbc | The classes that make up the connector that accesses the database schema metadata exposed by JDBC drivers for existing relational databases.
org.modeshape.connector.scm | The classes that define the SVN actions.
org.modeshape.connector.store.jpa | The classes that make up the connector that stores content in a relational database via JDBC and JPA.
org.modeshape.connector.store.jpa.model.common | The classes that define the common JPA entities used in multiple storage models.
org.modeshape.connector.store.jpa.model.simple | The classes that define the "simple" storage model for the JPA connector.
org.modeshape.connector.store.jpa.util | The classes that define the utility JPA entities that are not part of any storage model.
org.modeshape.connector.svn | The classes that make up the connector that accesses content from an SVN repository.
org.modeshape.connector.svn.mgnt | The classes that implement the SVN modification actions.
org.modeshape.graph.connector.federation | ModeShape provides a federated connector that is able to access repository content from multiple external systems and make that content look like it exists in a single unified repository.
org.modeshape.graph.connector.inmemory | The In-Memory Connector represents a `connector` that maintains a graph in transient in-process memory.

Sequencers
org.modeshape.sequencer.classfile | The classes that provide the ability to sequence Java class files into metadata and then write that metadata to a graph in a customizable way.
org.modeshape.sequencer.classfile.metadata | The classes that are immutable representations of metadata appearing in Java class files.
org.modeshape.sequencer.cnd | The classes that make up the JCR Compact Node Definition (CND) file sequencer.
org.modeshape.sequencer.ddl | The classes that make up the DDL sequencer, which is capable of parsing the more important DDL statements from SQL-92, Oracle, Derby, and PostgreSQL, and constructing a graph structure containing a structured representation of these statements.
org.modeshape.sequencer.ddl.datatype | The classes for parsing and representing data types.
org.modeshape.sequencer.ddl.dialect.db2 | The classes for parsing DDL for the DB2 DBMS.
org.modeshape.sequencer.ddl.dialect.derby | The classes for parsing DDL for the Derby DBMS.
org.modeshape.sequencer.ddl.dialect.mysql | The (prototype) classes for parsing DDL for the MySQL DBMS.
org.modeshape.sequencer.ddl.dialect.oracle | The classes for parsing DDL for the Oracle DBMS.
org.modeshape.sequencer.ddl.dialect.postgres | The classes for parsing DDL for the PostgreSQL DBMS.
org.modeshape.sequencer.ddl.dialect.sqlserver | The (prototype) classes for parsing DDL for the Microsoft SQLServer DBMS.
org.modeshape.sequencer.ddl.dialect.sybase | The (prototype) classes for parsing DDL for the Sybase DBMS.
org.modeshape.sequencer.ddl.node | The classes for nodes within an Abstract Syntax Tree (AST) and a factory for creating them.
org.modeshape.sequencer.image | The classes that make up the image sequencer.
org.modeshape.sequencer.java | The classes that make up the Java source file sequencer.
org.modeshape.sequencer.java.metadata | The classes that make up the metadata definitions for the Java source file sequencer.
org.modeshape.sequencer.jpdl3 | The classes that make up the jPDL3 file sequencer.
org.modeshape.sequencer.mp3 | The classes that make up the MP3 file sequencer.
org.modeshape.sequencer.msoffice | The classes that make up the sequencer of Microsoft Office files.
org.modeshape.sequencer.msoffice.excel | The classes for reading Microsoft Excel metadata.
org.modeshape.sequencer.msoffice.powerpoint | The classes for reading Microsoft PowerPoint metadata.
org.modeshape.sequencer.msoffice.word | The classes for reading Microsoft Word metadata.
org.modeshape.sequencer.sramp | The classes that make up the S-RAMP library.
org.modeshape.sequencer.teiid | The classes that make up the JCR Compact Node Definition (CND) file sequencer.
org.modeshape.sequencer.teiid.lexicon |
org.modeshape.sequencer.text | The classes that provide the ability to sequence fixed-width and delimited text files.
org.modeshape.sequencer.wsdl | The classes that make up the Web Service Definition Lanaguage (WSDL) 1.1 sequencer.
org.modeshape.sequencer.xml | The classes that make up the XML sequencer.
org.modeshape.sequencer.xsd | The classes that make up the XML Schema Document sequencer.
org.modeshape.sequencer.zip | The classes that make up the ZIP file sequencer.

MIME type detectors
org.modeshape.mimetype.aperture | The classes that make up the Aperture MIME type detector.

Text extractors
org.modeshape.extractor.teiid | The package containing the Teiid VDB text extractor implementation.
org.modeshape.extractor.tika | The classes that make up the `TextExtractor` implementation that uses the Apache Tika `Parser` implementations.

Other Packages
org.modeshape.clustering |
org.modeshape.cnd | Compact Node Definition (CND) defines JCR node types, property definitions, and child node definitions in a concise and easy-to-read form.
org.modeshape.common | The parent package for the common, low-level utilities and simple frameworks for all of ModeShape.
org.modeshape.common.annotation |
org.modeshape.common.collection | A set of common classes for dealing with collections of other objects.
org.modeshape.common.component | A simple framework for loading and managing `Component` objects that may be configured and used reflectively.
org.modeshape.common.i18n | A simple framework for defining internationalized strings and obtaining the localized forms.
org.modeshape.common.naming | A simple and limited `JNDI naming context` and `InitialContext factory implementation` that can be used in unit tests or other code that uses JNDI to `looks up` objects.
org.modeshape.common.text | A set of utilities for working with text.
org.modeshape.common.util | A set of miscellaneous utilities.
org.modeshape.common.util.log |
org.modeshape.common.xml | A set of utilities for working with XML documents.
org.modeshape.jcr.query |
org.modeshape.jcr.query.qom |
org.modeshape.jcr.security | ModeShape JCR repositories have a pluggable authentication and authorization framework.
org.modeshape.jdbc |
org.modeshape.jdbc.delegate |
org.modeshape.jdbc.metadata |
org.modeshape.jdbc.types |
org.modeshape.jdbc.util |
org.modeshape.repository | The components and services that make up ModeShape's lower-level graph engine, which is used within its JCR Engine.
org.modeshape.util | Some utilities that are useful for ModeShape, including the `DDL generator` for the various kinds of databases used by the `JPA connector`.
org.modeshape.web.jcr | This package contains the core components for the ModeShape common web library.
org.modeshape.web.jcr.spi | Service provider interface (SPI) for the JCR implementation that backs the ModeShape web libraries.
org.modeshape.web.jcr.webdav | This package contains the core components for the ModeShape WebDAV server implementation.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

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