# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
#
# Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
#
# The contents of this file are subject to the terms of either the GNU
# General Public License Version 2 only ("GPL") or the Common
# Development and Distribution License("CDDL") (collectively, the
# "License"). You may not use this file except in compliance with the
# License. You can obtain a copy of the License at
# http://www.netbeans.org/cddl-gplv2.html
# or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
# specific language governing permissions and limitations under the
# License.  When distributing the software, include this License Header
# Notice in each file and include the License file at
# nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
# particular file as subject to the "Classpath" exception as provided
# by Sun in the GPL Version 2 section of the License file that
# accompanied this code. If applicable, add the following below the
# License Header, with the fields enclosed by brackets [] replaced by
# your own identifying information:
# "Portions Copyrighted [year] [name of copyright owner]"
#
# Contributor(s):
#
# The Original Software is NetBeans. The Initial Developer of the Original
# Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
# Microsystems, Inc. All Rights Reserved.
#
# If you wish your version of this file to be governed by only the CDDL
# or only the GPL Version 2, indicate your decision by adding
# "[Contributor] elects to include this software in this distribution
# under the [CDDL or GPL Version 2] license." If you do not indicate a
# single choice of license, a recipient has the option to distribute
# your version of this file under either the CDDL, the GPL Version 2 or
# to extend the choice of license to its licensees as provided above.
# However, if you add GPL Version 2 code and therefore, elected the GPL
# Version 2 license, then the option applies only if the new code is
# made subject to such option by the copyright holder.


Last modified: June 24, 2003

BUILDING THE CLASSIFICATION FRAMEWORK
=====================================

Unpack the classifier_dist.zip archive into your NetBeans build directory
(e.g. nb_all), so the directory structure is like this:

+- nb_all
   +- classifier
      +- examples
      +- libsrc
      +- src
      ...

Make sure you have Ant 1.5.x installed on your system.

Go to the 'classifier' directory and type 'ant'.

The classifier library will be created in directory

classifier/netbeans/modules


RUNNING THE EXAMPLES
====================

Go to the 'examples' directory ant type 'ant'.

The output of the example classification will be printed to the console.

STATUS
======

The classification framework currently implements the following features:

- API to query for classifications for a particular object
- SPI to provide external predicates and to construct classifiers
- XML-based language to write classification programs
- Basic algorithm to retrieve classifications for an object
- Handful of predefined external predicates

The following features are NOT yet implemented at this point:

- Ordering of classes in the classification result
- Handling priorities in classification programs
- Handling of URL constants in classification programs
- Listening on changes in the previously classified objects
- Most planned external predicates (e.g. FileSystems API ones)
- Support for changing (reloading/refreshing) the program at runtime
- Regression tests
- Creating the Javadoc by the build
- LookSelector that would select looks based on the classifications