001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/annotators/Annotator.java,v 1.1.1.1 2004/03/25 12:08:37 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:37 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruņa
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruņa nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.kernel.model.annotators;
042:
043: import es.udc.mypersonalizer.kernel.model.metainfo.MetaCompoundProperty;
044: import es.udc.mypersonalizer.kernel.model.metainfo.MetaService;
045: import es.udc.mypersonalizer.kernel.model.metainfo.MetaSimpleProperty;
046: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
047:
048: /**
049: * Interface for adding annotations to a <code>MetaService</code> or
050: * <code>MetaProperty</code>.
051: * <p>
052: * Implementations of this interface receive a target object and the annotations
053: * that must be set, as specified by any external ways (for example, by a
054: * configuration file). The implementation must complete this external
055: * annotations with defaults for any other required annotation, and
056: * add the resulting annotations to the target object.
057: * <p>
058: * Annotators to be used as persistence annotators must implement a default
059: * (zero arguments) constructor.
060: * <p>
061: * <code>Annotator</code> instances will <b>not</b> be reused, so they can
062: * keep internal state.
063: * <p>
064: * Implementors of this interface can expect the annotation requests to arrive
065: * in depth order following the metainformation tree: starting at the root
066: * (the <code>MetaService</code> object) and descending through the
067: * root property, then each of its children recursively.
068: *
069: * @see es.udc.mypersonalizer.kernel.config.PersistenceTypeConfig
070: * @author Abel Muinho
071: * @since 1.0
072: */
073: public interface Annotator {
074:
075: /**
076: * Annotate a <code>MetaService</code>.
077: * @param metaService the metaservice to annotate.
078: * @param annotations the provided annotations. Must be <b>not</b>
079: * <code>null</code>.
080: * @throws InternalErrorException if errors are detected during the
081: * operation.
082: */
083: public void annotate(MetaService metaService,
084: Annotations annotations) throws InternalErrorException;
085:
086: /**
087: * Annotate a <code>MetaSimpleProperty</code>,
088: * @param metaSimpleProperty the metaproperty to annotate.
089: * @param annotations the provided annotations. Must be <b>not</b>
090: * <code>null</code>.
091: * @throws InternalErrorException if errors are detected during the
092: * operation.
093: */
094: public void annotate(MetaSimpleProperty metaSimpleProperty,
095: Annotations annotations) throws InternalErrorException;
096:
097: /**
098: * Annotate a <code>MetaCompoundProperty</code>.
099: * @param metaCompoundProperty the metaproperty to annotate.
100: * @param annotations the provided annotations. Must be <b>not</b>
101: * <code>null</code>.
102: * @throws InternalErrorException if errors are detected during the
103: * operation.
104: */
105: public void annotate(MetaCompoundProperty metaCompoundProperty,
106: Annotations annotations) throws InternalErrorException;
107: }
|