# ModeShape Distribution Library Reference (4.0.0.Final)

ModeShape API (extends JCR API)
Package | Description
--- | ---
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.monitor | This package provides a set of interfaces and enumerations used for monitoring ModeShape repositories.
org.modeshape.jcr.api.nodetype | This package contains the `NodeTypeManager` interface, which extends the standard `NodeTypeManager` interface of the JCR 2.0 API and adds several convenient methods for registering node types from CND files and Jackrabbit XML files.
org.modeshape.jcr.api.observation |
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.api.value |

ModeShape JDBC Driver
Package | Description
--- | ---
org.modeshape.jdbc |
org.modeshape.jdbc.delegate |
org.modeshape.jdbc.metadata |
org.modeshape.jdbc.types |
org.modeshape.jdbc.util |

ModeShape engine
Package | Description
--- | ---
org.modeshape.jcr |
org.modeshape.jcr.api.federation |
org.modeshape.jcr.api.index |
org.modeshape.jcr.api.version |
org.modeshape.jcr.bus |
org.modeshape.jcr.cache |
org.modeshape.jcr.cache.change |
org.modeshape.jcr.cache.document |
org.modeshape.jcr.clustering |
org.modeshape.jcr.federation |
org.modeshape.jcr.index.local |
org.modeshape.jcr.journal |
org.modeshape.jcr.query | The Query API provides a mechanism for building and executing queries.
org.modeshape.jcr.query.engine | This package contains several fully-functional query engine implementations.
org.modeshape.jcr.query.engine.process | When executing a query, the processing phase involves "running" each branch in the optimized query plan, determining the set of nodes that satisfies each branch, and then joining each branch into a single result.
org.modeshape.jcr.query.model | The Abstract Query Model is a vocabulary that can be used to construct a language-neutral representation of a query.
org.modeshape.jcr.query.optimize | This package contains the Optimizer interface, a rule-based optimizer implementation, and library of optimization rules.
org.modeshape.jcr.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.jcr.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.jcr.query.validate | This package provides the interfaces that define the tables and columns that can be queried.
org.modeshape.jcr.query.xpath | The components used to parse JCR XPath queries and translate them into equivalent JCR-SQL2 queries.
org.modeshape.jcr.security | ModeShape JCR repositories have a pluggable authentication and authorization framework.
org.modeshape.jcr.security.acl |
org.modeshape.jcr.sequencer |
org.modeshape.jcr.text | This package defines an interface for components that `extract text` from content.
org.modeshape.jcr.txn |
org.modeshape.jcr.value | 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.jcr.value.basic | A set of basic implementations of the various interfaces defined in `org.modeshape.jcr.value`.
org.modeshape.jcr.value.binary |
org.modeshape.jcr.value.binary.infinispan |
org.modeshape.jcr.xml |

ModeShape SPI for Extensions
Package | Description
--- | ---
org.modeshape.jcr.api.sequencer | Many repositories are used (at least in part) to manage files and other artifacts, including service definitions, policy files, images, media, documents, presentations, application components, reusable libraries, configuration files, application installations, databases schemas, management scripts, and so on.
org.modeshape.jcr.api.text |
org.modeshape.jcr.spi.federation | This package provides a Service Provider Interface (SPI) for connectors to external systems.
org.modeshape.jcr.spi.index | This package contains the interfaces for managing index providers and index definitions.
org.modeshape.jcr.spi.index.provider | This package contains the Service Provider Interface (SPI) for custom index providers, which are components that encapsulate how ModeShape updates and uses a set of particular indexes.

ModeShape Provided Sequencers
Package | Description
--- | ---
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 |
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.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.teiid |
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.javafile | The classes that make up the Java source file sequencer.
org.modeshape.sequencer.javafile.metadata | The classes that make up the metadata definitions for the Java source 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 Teiid VDB sequencer.
org.modeshape.sequencer.teiid.lexicon |
org.modeshape.sequencer.teiid.model | The classes that make up the Teiid model sequencer.
org.modeshape.sequencer.teiid.xmi | The classes that make up the XMI reader used by the Teiid VDB and model sequencers.
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.

ModeShape Provided Connectors
Package | Description
--- | ---
org.modeshape.connector.filesystem |
org.modeshape.connector.git |
org.modeshape.connector.meta.jdbc |

ModeShape Provided Mime Type Detectors
Package | Description
--- | ---
org.modeshape.jcr.mimetype | This package defines an internal adapter framework for detecting MIME types.

ModeShape Provided Text Extractors
Package | Description
--- | ---
org.modeshape.extractor.tika | The classes that make up the `TextExtractor` implementation that uses the Apache Tika `Parser` implementations.

ModeShape Web services
Package | Description
--- | ---
org.modeshape.web.jcr | This package contains the core components for the ModeShape common web library.
org.modeshape.webdav |
org.modeshape.webdav.exceptions |
org.modeshape.webdav.fromcatalina |
org.modeshape.webdav.locking |
org.modeshape.webdav.methods |

ModeShape Subsystem for AS7
Package | Description
--- | ---
org.modeshape.jboss.lifecycle |
org.modeshape.jboss.metric |
org.modeshape.jboss.service |
org.modeshape.jboss.subsystem |

Other Packages
Package | Description
--- | ---
org.infinispan.schematic |
org.infinispan.schematic.document |
org.infinispan.schematic.internal |
org.infinispan.schematic.internal.delta |
org.infinispan.schematic.internal.document |
org.infinispan.schematic.internal.io |
org.infinispan.schematic.internal.marshall |
org.infinispan.schematic.internal.schema |
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.collection.ring | A ring buffer and the components it uses internally.
org.modeshape.common.function |
org.modeshape.common.i18n | A simple framework for defining internationalized strings and obtaining the localized forms.
org.modeshape.common.logging |
org.modeshape.common.logging.jdk |
org.modeshape.common.logging.log4j |
org.modeshape.common.logging.slf4j |
org.modeshape.common.math | A set of classes that define mathematic operations for a particular class of values.
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.statistic | A set of utilities for working with statistics, including a `Stopwatch` and `Histogram`s.
org.modeshape.common.text | A set of utilities for working with text.
org.modeshape.common.util | A set of miscellaneous utilities.
org.modeshape.common.xml | A set of utilities for working with XML documents.
org.modeshape.jmx |

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