alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Id: AbstractWellformednessRule.java,v 1.7 2004/08/08 12:43:09 mvw Exp $
// Copyright (c) 2003 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.model.uml;

import org.argouml.i18n.Translator;

/**
 * Rule definition for wellformedness of some modelelement. In the UML
 * 1.3 spec so called wellformednessrules are defined. This class is
 * the abstract superclass of implementations of these rules.
 *
 * In several build methods in the uml factories these rules are
 * used. Furthermore they are used in the proppanels to veto some
 * changes.
 *
 * 
 * @author jaap.branderhorst@xs4all.nl
 * @since argouml 0.11.3
 */
public abstract class AbstractWellformednessRule {
    /**
     * the message key to be looked up to show the message to the user
     */
    private String key; 
	
    /**
     * Checks if the combination of the element and the newValue give
     * a wellformed result
     *
     * @param element a UML element
     * @param newValue the new value to be tested
     * @return true if wellformed
     */
    public abstract boolean isWellformed(
            Object/*MBase*/ element, 
            Object newValue);
	
    /**
     * Returns the localized user message
     *
     * @return the localized user message
     */
    public String getUserMessage() {
	return Translator.localize("UMLMenu", "wellformednessrule." + key);
    }
	
    /**
     * sets the message key. The message key here is of the form
     * elementname.propertytocheck
     *
     * Example:
     *
     * Say you want to check the namespace of an association. The key
     * will be here association.namespace
     * 
     * Keys are looked up in UMLResourceBundle for the time
     * being. Keys start with wellformednessrule. over there. This is
     * added to the key entered here.
     *
     * @param k the key
     */
    public void setUserMessageKey(String k) {
	key = k;
    }
	
    /**
     * Constructor 
     * @param k the key
     */
    public AbstractWellformednessRule(String k) {
	key = k;
    }
	
    /**
     * Constructor
     */
    public AbstractWellformednessRule() { }

}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.