/*
  Copyright (C) 2006 Helge Hess

  This file is part of JOPE.

  JOPE 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, or (at your option) any
  later version.

  JOPE 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 JOPE; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

package org.opengroupware.jope.appserver.associations;

import org.opengroupware.jope.appserver.core.WOAssociation;
import org.opengroupware.jope.foundation.NSKeyValueStringFormatter;

/*
 * WOKeyPathPatternAssociation
 * 
 * Evaluates String patterns which contain keypathes.
 * 
 * Example:
 *   Batch %(displayGroup.currentBatchIndex)i of %(displayGroup.batchCount)i
 */
public class WOKeyPathPatternAssociation extends WOAssociation {
  
  protected String pattern;
  
  public WOKeyPathPatternAssociation(String _pattern) {
    this.pattern = _pattern;
  }

  /* accessors */
  
  public String pattern() {
    return this.pattern;
  }
  
  @Override
  public String keyPath() {
    return this.pattern; /* hm, not strictly correct but maybe it useful ;-) */
  }
  
  /* reflection */
  
  @Override
  public boolean isValueConstant() {
    return false;
  }
  
  @Override
  public boolean isValueSettable() {
    return false;
  }
  
  @Override
  public boolean isValueConstantInComponent(Object _cursor) {
    return false;
  }
  
  @Override
  public boolean isValueSettableInComponent(Object _cursor) {
    return false;
  }
  
  /* values */
  
  @Override
  public String stringValueInComponent(Object _cursor) {
    if (this.pattern == null)
      return null;
    
    return NSKeyValueStringFormatter.format(this.pattern, _cursor);
  }
  
  @Override
  public Object valueInComponent(Object _cursor) {
    return this.stringValueInComponent(_cursor);
  }
  
  /* specific values */
  
  /* description */
  
  @Override
  public void appendAttributesToDescription(StringBuffer _d) {
    super.appendAttributesToDescription(_d);
    _d.append(" pattern=");
    _d.append(this.pattern);
  }
}