Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* $Id$
* $URL$
* ----------------------------------------------------------------------------
* This file is part of JSBML. Please visit
* for the latest version of JSBML and more information about SBML.
*
* Copyright (C) 2009-2016 jointly by the following organizations:
* 1. The University of Tuebingen, Germany
* 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
* 3. The California Institute of Technology, Pasadena, CA, USA
* 4. The University of California, San Diego, La Jolla, CA, USA
* 5. The Babraham Institute, Cambridge, UK
*
* 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. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as .
* ----------------------------------------------------------------------------
*/
package org.sbml.jsbml.ext.layout;
import java.util.Map;
import org.apache.log4j.Logger;
import org.sbml.jsbml.AbstractSBase;
import org.sbml.jsbml.SBMLException;
import org.sbml.jsbml.util.TreeNodeChangeEvent;
/**
* Parent class to {@link LineSegment} and {@link CubicBezier}.
*
* @author Sebastian Fröhlich
* @author Nicolas Rodriguez
* @since 1.0
* @version $Rev$
*/
public abstract class CurveSegment extends AbstractSBase {
/**
*
* @author Sebastian Fröhlich
* @author Nicolas Rodriguez
* @version $Rev$
* @since 1.0
*/
public enum Type
{
/**
*
*/
CUBIC_BEZIER("CubicBezier"),
/**
*
*/
LINE_SEGMENT("LineSegment");
/**
* @param value
* @return
*/
public static Type fromString(String value)
{
if (value == null)
{
throw new IllegalArgumentException();
}
for (Type v : values())
{
if (value.equalsIgnoreCase(v.getXmlString()))
{
return v;
}
}
throw new IllegalArgumentException();
}
/**
*
*/
private final String xmlString;
/**
* @param xmlString
*/
private Type(String xmlString) {
this.xmlString = xmlString;
}
/**
* Returns the xmlString
*
* @return the xmlString
*/
public String getXmlString() {
return xmlString;
}
/* (non-Javadoc)
* @see java.lang.Enum#toString()
*/
@Override
public String toString() {
return xmlString;
}
}
/**
* Generated serial version identifier.
*/
private static final long serialVersionUID = -5085246314333062152L;
/**
*
*/
private static final transient Logger logger = Logger.getLogger(CurveSegment.class);
/**
*
*/
private Type type;
/**
*
*/
public CurveSegment() {
super();
initDefaults();
}
/**
*
* @param curveSegment
*/
public CurveSegment(CurveSegment curveSegment) {
super(curveSegment);
if (curveSegment.isSetType()) {
setType(curveSegment.getType());
}
}
/**
*
* @param level
* @param version
*/
public CurveSegment(int level, int version) {
super(level, version);
initDefaults();
}
/**
* Creates, sets and returns an empty {@link Point}.
*
* @return a new {@link Point} object.
*/
abstract public Point createEnd();
/**
* Creates, sets and returns a {@link Point} based on the
* given values.
*
* @param x
* @param y
* @param z
* @return a new {@link Point} object.
*/
abstract public Point createEnd(double x, double y, double z);
/**
* Creates, sets and returns an empty {@link Point}.
*
* @return a new {@link Point} object.
*/
abstract public Point createStart();
/**
* Creates, sets and returns a {@link Point} based on the
* given values.
*
* @param x
* @param y
* @param z
* @return a new {@link Point} object.
*/
abstract public Point createStart(double x, double y, double z);
/* (non-Javadoc)
* @see org.sbml.jsbml.AbstractNamedSBase#equals(java.lang.Object)
*/
@Override
public boolean equals(Object object) {
boolean equals = super.equals(object);
if (equals) {
CurveSegment curveSegment = (CurveSegment) object;
equals &= curveSegment.isSetType() == isSetType();
if (equals && isSetType()) {
equals &= curveSegment.getType().equals(getType());
}
}
return equals;
}
/**
* Returns the {@code End} {@link Point} of this {@link CurveSegment}.
*
* @return the {@code End} {@link Point} of this {@link CurveSegment}.
*/
abstract public Point getEnd();
/**
* Returns the {@code Start} {@link Point} of this {@link CurveSegment}.
*
* @return the {@code Start} {@link Point} of this {@link CurveSegment}.
*/
abstract public Point getStart();
/**
*
* @return
*/
public Type getType() {
return type;
}
/* (non-Javadoc)
* @see org.sbml.jsbml.AbstractSBase#hashCode()
*/
@Override
public int hashCode() {
final int prime = 937;
int hashCode = super.hashCode();
if (isSetType()) {
hashCode += prime * getType().hashCode();
}
return hashCode;
}
/**
*
*/
private void initDefaults() {
setPackageVersion(-1);
packageName = LayoutConstants.shortLabel;
}
/**
*
* @return
*/
public boolean isCubicBezier() {
return type != null && type.equals(Type.CUBIC_BEZIER);
}
/**
*
* @return
*/
public boolean isLineSegment() {
return type != null && type.equals(Type.LINE_SEGMENT);
}
/**
* Returns {@code true} if the {@code End} {@link Point} is set.
*
* @return {@code true} if the {@code End} {@link Point} is set.
*/
abstract public boolean isSetEnd();
/**
* Returns {@code true} if the {@code Start} {@link Point} is set.
*
* @return {@code true} if the {@code Start} {@link Point} is set.
*/
abstract public boolean isSetStart();
/**
*
* @return
*/
public boolean isSetType() {
return type != null;
}
/* (non-Javadoc)
* @see org.sbml.jsbml.AbstractMathContainer#readAttribute(java.lang.String, java.lang.String, java.lang.String)
*/
@Override
public boolean readAttribute(String attributeName, String prefix,
String value) {
boolean isAttributeRead = super.readAttribute(attributeName, prefix,
value);
logger.debug("reading CurveSegmentImpl: " + prefix + ":" + attributeName);
if (!isAttributeRead) {
//TODO: will the xsi:type element be properly read? Create test for this...
if (attributeName.equals("type")) {
try
{
setType(Type.fromString(value));
}
catch (Exception e)
{
throw new SBMLException("Could not recognized the value '" + value
+ "' for the attribute " + LayoutConstants.type
+ " on the 'curveSegment' element.");
}
return true;
}
}
return isAttributeRead;
}
/**
*
* @return
*/
public Point removeEnd() {
if (!isSetEnd()) {
return null;
}
Point end = getEnd();
setEnd(null);
return end;
}
/**
*
* @return
*/
public Point removeStart() {
if (!isSetStart()) {
return null;
}
Point start = getStart();
setStart(null);
return start;
}
/**
* Sets the {@code End} {@link Point} of this {@link CurveSegment}.
*
* @param end the {@code End} {@link Point} to set
*/
abstract public void setEnd(Point end);
/**
* Sets the {@code Start} {@link Point} of this {@link CurveSegment}.
*
* @param start the {@code Start} {@link Point} to set
*/
abstract public void setStart(Point start);
/**
* Sets the {@link Type} of this {@link CurveSegment} to {@link LineSegment}
* or {@link CubicBezier}.
* @param type
*/
void setType(Type type)
{
Type oldType = this.type;
this.type = type;
firePropertyChange(TreeNodeChangeEvent.type, oldType, this.type);
}
/* (non-Javadoc)
* @see org.sbml.jsbml.AbstractNamedSBase#writeXMLAttributes()
*/
@Override
public Map writeXMLAttributes() {
Map attributes = super.writeXMLAttributes();
if (logger.isDebugEnabled())
{
logger.debug("process attributes of CurveSegmentImpl");
logger.debug("isSetType: " + isSetType());
logger.debug("Type = " + type);
}
if (isSetType()) {
attributes.put(LayoutConstants.xsiShortLabel + ":type", getType().toString());
}
return attributes;
}
}
