JBoss DNA API Reference (0.7)

JCR implementation
org.jboss.dna.cnd Compact Node Definition (CND) defines JCR node types, property definitions, and child node definitions in a concise and easy-to-read form.
org.jboss.dna.jcr The DNA implementation of the JCR API.
org.jboss.dna.jcr.nodetype The DNA specification for programmatically creating JCR NodeDefinitions.
org.jboss.dna.jcr.xpath  

 

Repository engine
org.jboss.dna.repository The components and services that make up the JBoss DNA repository engine.
org.jboss.dna.repository.sequencer The classes that make up the sequencing service and its configuration.
org.jboss.dna.repository.service The definition of common interfaces and classes for DNA services.
org.jboss.dna.repository.util Utility classes and methods for the JBoss DNA repository system.

 

Graph API
org.jboss.dna.graph The JBoss DNA Graph API defines the types that allow you to work with content organized as a graph.
org.jboss.dna.graph.io  
org.jboss.dna.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.jboss.dna.graph.property.basic A set of basic implementations of the various interfaces defined in org.jboss.dna.graph.property.
org.jboss.dna.graph.request Sometimes its useful to work with a graph using objects that represent individual commands on the graph.
org.jboss.dna.graph.request.processor This portion of the JBoss DNA Graph API defines the processor for requests.
org.jboss.dna.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.jboss.dna.graph.xml Graph content can often be represented in XML, so this part of the JBoss DNA Graph API defines the classes that provide the binding between graph and XML content.

 

Connectors
org.jboss.dna.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.jboss.dna.connector.infinispan The classes that make up the connector that stores content in a deployed instance of Infinispan.
org.jboss.dna.connector.jbosscache The classes that make up the connector that stores content in a JBoss Cache instance.
org.jboss.dna.connector.meta.jdbc  
org.jboss.dna.connector.scm The classes that define the SVN actions.
org.jboss.dna.connector.store.jpa The classes that make up the connector that stores content in a relational database via JDBC and JPA.
org.jboss.dna.connector.store.jpa.model.basic The classes that define the "basic" storage model for the JPA connector.
org.jboss.dna.connector.store.jpa.model.common The classes that define the common JPA entities used in multiple storage models.
org.jboss.dna.connector.store.jpa.model.simple The classes that define the "simple" storage model for the JPA connector.
org.jboss.dna.connector.store.jpa.util The classes that define the utility JPA entities that are not part of any storage model.
org.jboss.dna.connector.svn The classes that make up the connector that accesses content from an SVN repository.
org.jboss.dna.connector.svn.mgnt  
org.jboss.dna.graph.cache Caching of graph content is controlled with cache policies, and these are used in connectors and in requests (among other places).
org.jboss.dna.graph.connector JBoss DNA uses connectors to access information from external systems (such as databases, other repositories, services, applications, etc.) and create graph representations of that information.
org.jboss.dna.graph.connector.federation JBoss DNA 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.jboss.dna.graph.connector.inmemory The In-Memory Connector represents a connector that maintains a graph in transient in-process memory.
org.jboss.dna.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.jboss.dna.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.jboss.dna.graph.connector.path.cache The PathRepositoryCache class and its supporting classes provide a standard caching mechanism for path-based repositories.

 

Sequencers
org.jboss.dna.graph.sequencer A sequencer in JBoss DNA 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.
org.jboss.dna.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.jboss.dna.sequencer.classfile.metadata  
org.jboss.dna.sequencer.cnd The classes that make up the JCR Compact Node Definition (CND) file sequencer.
org.jboss.dna.sequencer.ddl  
org.jboss.dna.sequencer.ddl.datatype  
org.jboss.dna.sequencer.ddl.dialect.db2  
org.jboss.dna.sequencer.ddl.dialect.derby  
org.jboss.dna.sequencer.ddl.dialect.mysql  
org.jboss.dna.sequencer.ddl.dialect.oracle  
org.jboss.dna.sequencer.ddl.dialect.postgres  
org.jboss.dna.sequencer.ddl.dialect.sqlserver  
org.jboss.dna.sequencer.ddl.dialect.sybase  
org.jboss.dna.sequencer.ddl.node  
org.jboss.dna.sequencer.image The classes that make up the image sequencer.
org.jboss.dna.sequencer.java The classes that make up the Java source file sequencer.
org.jboss.dna.sequencer.java.metadata The classes that make up the metadata definitions for the Java source file sequencer.
org.jboss.dna.sequencer.jpdl3 The classes that make up the jPDL3 file sequencer.
org.jboss.dna.sequencer.mp3 The classes that make up the MP3 file sequencer.
org.jboss.dna.sequencer.msoffice The classes that make up the sequencer of Microsoft Office files.
org.jboss.dna.sequencer.msoffice.excel The classes for reading Microsoft Excel metadata.
org.jboss.dna.sequencer.msoffice.powerpoint The classes for reading Microsoft PowerPoint metadata.
org.jboss.dna.sequencer.msoffice.word The classes for reading Microsoft Word metadata.
org.jboss.dna.sequencer.text The classes that provide the ability to sequence fixed-width and delimited text files.
org.jboss.dna.sequencer.xml The classes that make up the XML sequencer.
org.jboss.dna.sequencer.zip The classes that make up the ZIP file sequencer.

 

MIME type detectors
org.jboss.dna.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.
org.jboss.dna.mimetype.aperture The classes that make up the Aperture MIME type detector.

 

Web services
org.jboss.dna.web.jcr.rest This package contains the core components for the DNA REST server implementation.
org.jboss.dna.web.jcr.rest.client The JBoss DNA REST Client is a lightweight, non-UI Maven project that interacts with the DNA REST server.
org.jboss.dna.web.jcr.rest.client.domain The JBoss DNA REST Client domain package defines the DNA and JCR business objects.
org.jboss.dna.web.jcr.rest.client.http  
org.jboss.dna.web.jcr.rest.client.json The JBoss DNA REST Client JSON package defines an implementation of an DNA REST client.
org.jboss.dna.web.jcr.rest.model Models for the DNA interface to faciliate serving basic information as XML or JSON in the future.
org.jboss.dna.web.jcr.rest.spi Service provider interface (SPI) for the JCR implementation that backs the DNA JCR REST server.

 

Common utilities
org.jboss.dna.common The parent package for the common, low-level utilities and simple frameworks for all of JBoss DNA.
org.jboss.dna.common.collection A set of common classes for dealing with collections of other objects.
org.jboss.dna.common.component A simple framework for loading and managing Component objects that may be configured and used reflectively.
org.jboss.dna.common.i18n A simple framework for defining internationalized strings and the mechanism by which the strings are localized.
org.jboss.dna.common.math A set of classes that define mathematic operations for a particular class of values.
org.jboss.dna.common.statistic A set of utilities for working with statistics, including a Stopwatch and Histograms.
org.jboss.dna.common.text A set of utilities for working with text.
org.jboss.dna.common.util A set of miscellaneous utilities.
org.jboss.dna.common.xml A set of utilities for working with XML documents.

 

Other Packages
org.jboss.dna.graph.observe The Observation API provides several mechanisms for asynchronously observing changes to content.
org.jboss.dna.graph.query The Query API provides a mechanism for building and executing queries.
org.jboss.dna.graph.query.model The Abstract Query Model is a vocabulary that can be used to construct a language-neutral representation of a query.
org.jboss.dna.graph.query.optimize This package contains the Optimizer interface, a rule-based optimizer implementation, and library of optimization rules.
org.jboss.dna.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.jboss.dna.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.jboss.dna.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.jboss.dna.graph.query.validate This package provides the interfaces that define the tables and columns that can be queried.
org.jboss.dna.graph.search  
org.jboss.dna.maven The classes that make up the Maven classloader system.
org.jboss.dna.maven.spi The classes that define the SPI for the Maven classloader system.
org.jboss.dna.search.lucene  
org.jboss.dna.search.lucene.query  
org.jboss.dna.util  

 



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