/*
    * Copyright (C) 2004 TiongHiang Lee
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    * License as published by the Free Software Foundation; either
    * version 2.1 of the License, or (at your option) any later version.
    *
    * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not,  write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   *
   * Email: thlee@onemindsoft.org
   */
  
  package org.onemind.commons.relabean;
  
  import java.beans.FeatureDescriptor;
  import java.io.IOException;
  import java.io.Writer;
  import java.lang.reflect.Method;
  /***
   * Describe relation between a bean and another bean
   * 
   * @author TiongHiang Lee (thlee@onemindsoft.org)
   * @version $Id: RelationDescriptor.java,v 1.2 2004/08/26 16:28:58 thlee Exp $ $Name:  $
   */
  public class RelationDescriptor extends FeatureDescriptor
  {
  
      /*** name * */
      private String _name;
  
      /*** the relation type * */
      private Class _relationType;
  
      /*** the set method * */
      private Method _writeMethod;
  
      /*** the get method * */
      private Method _readMethod;
  
      /*** the add method * */
      private Method _addMethod;
  
      /*** the remove method * */
      private Method _removeMethod;
  
      /*** the member type * */
      private Class _memberType;
  
      /***
       * Constructor {@inheritDoc}
       */
      public RelationDescriptor(String name, Class type, Method readMethod,
              Method writeMethod)
      {
          _name = name;
          _relationType = type;
          _readMethod = readMethod;
          _writeMethod = writeMethod;
      }
  
      /***
       * Constructor {@inheritDoc}
       */
      public RelationDescriptor(String name, Class type, Method readMethod,
              Method writeMethod, Class memberType, Method addMethod,
              Method removeMethod)
      {
          this(name, type, readMethod, writeMethod);
          _memberType = memberType;
          _addMethod = addMethod;
          _removeMethod = removeMethod;
      }
  
      /***
       * Returns the getMethod.
       * 
       * @return the getMethod.
       */
      public Method getReadMethod()
      {
          return _readMethod;
      }
  
      /***
       * Returns the name.
       * 
       * @return the name
       */
      public String getName()
      {
          return _name;
     }
 
     /***
      * Returns the removeMethod.
      * 
      * @return the remove method
      */
     public Method getRemoveMethod()
     {
         return _removeMethod;
     }
 
     /***
      * Returns the writeMethod.
      * 
      * @return the writeMethod
      */
     public Method getWriteMethod()
     {
         return _writeMethod;
     }
 
     /***
      * Get the add method
      * 
      * @return the add method
      */
     public Method getAddMethod()
     {
         return _addMethod;
     }
 
     /***
      * Set the method
      * 
      * @param method the set method
      */
     public void setAddMethod(Method method)
     {
         _addMethod = method;
     }
 
     /***
      * Return relation type
      * 
      * @return the relation type
      */
     public Class getRelationType()
     {
         return _relationType;
     }
 
     /***
      * Dump the property
      * 
      * @param prefix the prefix
      * @param writer the writer
      * @throws IOException if there's IO problem
      */
     public void dump(String prefix, Writer writer) throws IOException
     {
         writer.write(prefix + "Relation name: " + getName() + "\n");
         writer.write(prefix + "\ttype: " + getRelationType() + "\n");
         writer.write(prefix + "\tmember type: " + getMemberType() + "\n");
         writer.write(prefix + "\treadMethod: " + getReadMethod() + "\n");
         writer.write(prefix + "\twriteMethod: " + getWriteMethod() + "\n");
         writer.write(prefix + "\taddMethod: " + getAddMethod() + "\n");
         writer.write(prefix + "\tremoveMethod: " + getRemoveMethod() + "\n");
     }
 
     /***
      * Get the member type
      * 
      * @return the member type
      */
     public Class getMemberType()
     {
         return _memberType;
     }
 
     /***
      * Set the member type
      * 
      * @param c the member type to set
      */
     public void setMemberType(Class c)
     {
         _memberType = c;
     }
 
     /***
      * Set the read method
      * 
      * @param method the read method
      */
     public void setReadMethod(Method method)
     {
         _readMethod = method;
     }
 
     /***
      * Set the relation type
      * 
      * @param class1 the type
      */
     public void setRelationType(Class class1)
     {
         _relationType = class1;
     }
 
     /***
      * Set the remove method
      * 
      * @param method the method
      */
     public void setRemoveMethod(Method method)
     {
         _removeMethod = method;
     }
 
     /***
      * Set the write method
      * 
      * @param method the method
      */
     public void setWriteMethod(Method method)
     {
         _writeMethod = method;
     }
 }