eu.etaxonomy.cdm.model.common
Class Marker

java.lang.Object
  extended by eu.etaxonomy.cdm.model.common.CdmBase
      extended by eu.etaxonomy.cdm.model.common.VersionableEntity
          extended by eu.etaxonomy.cdm.model.common.Marker
All Implemented Interfaces:
ICdmBase, IVersionableEntity, Serializable, Cloneable

@Entity
public class Marker
extends VersionableEntity
implements Cloneable

This class aims to make available some "flags" for identifiable entities in a flexible way. Application developers (and even users) can define their own "flags" as a MarkerType.

Version:
1.0
Author:
m.doering
See Also:
Serialized Form

Field Summary
 
Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase
uuid
 
Constructor Summary
protected Marker(MarkerType markerType, boolean flag)
          Constructor
 
Method Summary
 Object clone()
          Clones this versionable entity.
 Marker clone(AnnotatableEntity markedObject)
          Clones this marker and sets the clones marked object to 'markedObject'
 boolean getFlag()
          The flag value.
 AnnotatableEntity getMarkedObj()
           
 MarkerType getMarkerType()
           
 boolean getValue()
           
static Marker NewInstance()
          Factory method
static Marker NewInstance(AnnotatableEntity annotatedObject, boolean flag, MarkerType markerType)
           
static Marker NewInstance(MarkerType markerType, boolean flag)
          Factory method
 void setFlag(boolean flag)
           
 void setMarkedObj(AnnotatableEntity newMarkedObject)
           
 void setMarkerType(MarkerType type)
           
 
Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity
equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
 
Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase
addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase
getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid
 

Constructor Detail

Marker

protected Marker(MarkerType markerType,
                 boolean flag)
Constructor

Parameters:
flag -
Method Detail

NewInstance

public static Marker NewInstance()
Factory method

Returns:

NewInstance

public static Marker NewInstance(MarkerType markerType,
                                 boolean flag)
Factory method

Parameters:
markerType - The type of the marker
flag - The value of the marker
Returns:

NewInstance

public static Marker NewInstance(AnnotatableEntity annotatedObject,
                                 boolean flag,
                                 MarkerType markerType)

getMarkedObj

public AnnotatableEntity getMarkedObj()
Returns:

setMarkedObj

public void setMarkedObj(AnnotatableEntity newMarkedObject)

getMarkerType

public MarkerType getMarkerType()
Returns:

setMarkerType

public void setMarkerType(MarkerType type)

getFlag

public boolean getFlag()
The flag value.

Returns:

setFlag

public void setFlag(boolean flag)

getValue

public boolean getValue()
Returns:
See Also:
getFlag()

clone

public Object clone()
             throws CloneNotSupportedException
Description copied from class: VersionableEntity
Clones this versionable entity. Set fields for nextVersion, previousVersion, updated, updatedBy and createdBy are set to null The id is set to 0. The uuid is created new. The createdWhen is set to the current date.

Overrides:
clone in class VersionableEntity
Throws:
CloneNotSupportedException
See Also:
Object.clone()

clone

public Marker clone(AnnotatableEntity markedObject)
             throws CloneNotSupportedException
Clones this marker and sets the clones marked object to 'markedObject'

Throws:
CloneNotSupportedException
See Also:
Object.clone()


Copyright © 2007-2013 EDIT. All Rights Reserved.