notio
Class CopyingScheme

java.lang.Object
  |
  +--notio.CopyingScheme

public class CopyingScheme
extends java.lang.Object

A class used to specify how copying of graph elements should be performed. When copying graphs or graph components, a CopyingScheme instance is used to describe exactly how copying should be performed. Not all copying schemes need be implemented by a given implementation and many schemes would not make sense. The exact behaviour of an implementation under these circumstances is undefined but it is recommended that the implementation throw notio.UnimplementedFeatureException either when an invalid scheme is constructed or when it is used in a copying method. CopyingScheme instances may be reused as they are not altered by the copying process.

See Also:
UnimplementedFeatureException

Field Summary
static int CN_COPY_DUPLICATE
          Concept copy control flag: a duplicate node will be created.
static int CN_COPY_REFERENCE
          Concept copy control flag: a reference to the existing node will be used.
static int COMM_COPY_OFF
          Comment copy control flag: node and graph comments will not be copied.
static int COMM_COPY_ON
          Comment copy control flag: node and graph comments will be copied.
static int DG_COPY_DUPLICATE
          Designator copy control flag: a duplicate designator will be created.
static int DG_COPY_REFERENCE
          Designator copy control flag: a reference to the existing designator will be used.
static int GR_COPY_DUPLICATE
          Graph copy control flag: a duplicate graph will be created.
static int GR_COPY_REFERENCE
          Graph copy control flag: a reference to the existing graph will be used.
static int RN_COPY_DUPLICATE
          Relation copy control flag: a duplicate node will be created.
static int RN_COPY_REFERENCE
          Relation copy control flag: a reference to the existing node will be used.
 
Constructor Summary
CopyingScheme(int newGraphFlag, int newConceptFlag, int newRelationFlag, int newDesignatorFlag, int newCommentFlag, CopyingScheme newNestedScheme)
          Constructs a copying scheme with the specified control flags.
 
Method Summary
 int getCommentFlag()
          Returns the comment copying control flag for this scheme.
 int getConceptFlag()
          Returns the concept copying control flag for this scheme.
 int getDesignatorFlag()
          Returns the designator copying control flag for this scheme.
 int getGraphFlag()
          Returns the graph copying control flag for this scheme.
 CopyingScheme getNestedCopyingScheme()
          Returns the nested copying scheme or null.
 int getRelationFlag()
          Returns the relation copying control flag for this scheme.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GR_COPY_DUPLICATE

public static final int GR_COPY_DUPLICATE
Graph copy control flag: a duplicate graph will be created.

GR_COPY_REFERENCE

public static final int GR_COPY_REFERENCE
Graph copy control flag: a reference to the existing graph will be used.

CN_COPY_DUPLICATE

public static final int CN_COPY_DUPLICATE
Concept copy control flag: a duplicate node will be created.

CN_COPY_REFERENCE

public static final int CN_COPY_REFERENCE
Concept copy control flag: a reference to the existing node will be used.

RN_COPY_DUPLICATE

public static final int RN_COPY_DUPLICATE
Relation copy control flag: a duplicate node will be created.

RN_COPY_REFERENCE

public static final int RN_COPY_REFERENCE
Relation copy control flag: a reference to the existing node will be used.

DG_COPY_DUPLICATE

public static final int DG_COPY_DUPLICATE
Designator copy control flag: a duplicate designator will be created.

DG_COPY_REFERENCE

public static final int DG_COPY_REFERENCE
Designator copy control flag: a reference to the existing designator will be used.

COMM_COPY_OFF

public static final int COMM_COPY_OFF
Comment copy control flag: node and graph comments will not be copied.

COMM_COPY_ON

public static final int COMM_COPY_ON
Comment copy control flag: node and graph comments will be copied.
Constructor Detail

CopyingScheme

public CopyingScheme(int newGraphFlag,
                     int newConceptFlag,
                     int newRelationFlag,
                     int newDesignatorFlag,
                     int newCommentFlag,
                     CopyingScheme newNestedScheme)
Constructs a copying scheme with the specified control flags.
Parameters:
newGraphFlag - Copying flag for graphs.
newConceptFlag - Copying flag for concepts.
newRelationFlag - Copying flag for relations.
newDesignatorFlag - Copying flag for designators.
newCommentFlag - Copying flag for comments.
newNestedScheme - A nested copying scheme to be used for copying nested graphs (null means use present scheme).
Method Detail

getGraphFlag

public int getGraphFlag()
Returns the graph copying control flag for this scheme.
Returns:
the graph copying control flag for this scheme.

getConceptFlag

public int getConceptFlag()
Returns the concept copying control flag for this scheme.
Returns:
the concept copying control flag for this scheme.

getRelationFlag

public int getRelationFlag()
Returns the relation copying control flag for this scheme.
Returns:
the relation copying control flag for this scheme.

getDesignatorFlag

public int getDesignatorFlag()
Returns the designator copying control flag for this scheme.
Returns:
the designator copying control flag for this scheme.

getCommentFlag

public int getCommentFlag()
Returns the comment copying control flag for this scheme.
Returns:
the comment copying control flag for this scheme.

getNestedCopyingScheme

public CopyingScheme getNestedCopyingScheme()
Returns the nested copying scheme or null. The nested copying scheme is used for copying nested graphs. If it is set to null, the current scheme is used.
Returns:
the nested copying scheme or null.


Copyright 1998-1999 Finnegan Southey