ModeShape Library Reference (2.4.0.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.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 NodeDefinitions.
org.modeshape.jcr.query  
org.modeshape.jcr.query.qom  
org.modeshape.jcr.xpath The components used to parse JCR XPath queries and translate them into equivalent JCR-SQL2 queries.

 

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.property.basic A set of basic implementations of the various interfaces defined in org.modeshape.graph.property.
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.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.
org.modeshape.search.lucene An implementation of the SearchEngine interface that uses the Lucene library.
org.modeshape.search.lucene.query A set of Lucene Query specializations that allow the LuceneSearchEngine to create Lucene queries with additional kinds of constraints.

 

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.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.

 

Web services
org.modeshape.web.jcr This package contains the core components for the ModeShape common web library.
org.modeshape.web.jcr.rest This package contains the core components for the ModeShape REST server implementation.
org.modeshape.web.jcr.rest.client The ModeShape REST Client is a lightweight, non-UI Maven project that interacts with the ModeShape REST server.
org.modeshape.web.jcr.rest.client.domain The ModeShape REST Client domain package defines the ModeShape and JCR business objects.
org.modeshape.web.jcr.rest.client.http The ModeShape REST Client abstraction of a HTTP client connection.
org.modeshape.web.jcr.rest.client.json The ModeShape REST Client JSON package defines an implementation of an ModeShape REST client.
org.modeshape.web.jcr.rest.model Models for the ModeShape interface to faciliate serving basic information as XML or JSON in the future.
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.

 

Connectors
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.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.xml The classes that make up the XML 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.

 

Classloaders
org.modeshape.maven The classes that make up the Maven classloader system.
org.modeshape.maven.spi The classes that define the SPI for the Maven classloader system.

 

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.math A set of classes that define mathematic operations for a particular class of values.
org.modeshape.common.statistic A set of utilities for working with statistics, including a Stopwatch and Histograms.
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.jboss.managed  
org.modeshape.jboss.managed.util  
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.repository.cluster  
org.modeshape.repository.sequencer The classes that make up the sequencing service and its configuration.
org.modeshape.repository.service The definition of common interfaces and classes for ModeShape services.
org.modeshape.repository.util Utility classes and methods for the ModeShape repository system.
org.modeshape.rhq.plugin  
org.modeshape.rhq.plugin.objects  
org.modeshape.rhq.plugin.util  
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.

 



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