Package hec.map.streamAlignment

Class BaseStreamAlignment

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.map.streamAlignment.BaseStreamAlignment

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, MapObjectInterface, StreamAlignmentIfc, StreamAlignmentNodeIfc, Serializable, Cloneable, Comparable, Observer, Modifiable

public class BaseStreamAlignment
extends NamedType
implements StreamAlignmentIfc

Stream coordinate system for model discretizations.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_NAME

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Constructor Summary

Constructors

Constructor	Description
BaseStreamAlignment()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	connectAlignment(double tolerance)	Iterates through the stream alignment connecting the stream elements together.
boolean	connectNode(StreamElement elem, StreamNode node, double tol)
void	connectReach(StreamElement elem, double tol)
StreamElement	createReach(StreamPolyLine line, double tol)
boolean	deleteAll()	Deletes all elements, nodes, and reaches.
boolean	deleteReach(int index)
boolean	deleteReach(String name)
void	deleteStreamNode(StreamNode node)
StreamNode	findDownstreamNode(StreamElement stream, double coord)
StreamElement	findNearestReach(WorldPt wpt, WorldPt wptbest)	finds the stream element nearest the given point.
StreamElement	findNearestReach(WorldPt wpt, WorldPt wptbest, double[] mindist)	finds the stream element nearest the given point.
StreamNode	findNearestStreamNode(StreamElement stream, WorldPt wpt)
StreamElement	findReach(int idx)
StreamElement	findReach(WorldPt wpt, double tol)	Finds a Reach that Contains the given World Point
StreamElement	findReach(WorldPt wpt, double tol, StreamElement rch0)	Finds a Reach that Contains the given World Point for creating reaches
StreamElement	findReach(StreamNode node, WorldPt wpt, double tol)	Finds a reach that contains the given world point but does not have the given node.
StreamElement	findReach(String name)
StreamJunction	findStreamJunction(StreamElement stream, WorldPt wpt, double tol)	look for the closest stream junction on the given stream near the given point
StreamNode	findStreamNode(StreamElement stream, WorldPt wpt, double tol)	look for a stream node on the given stream near the given point
StreamNode	findUpstreamNode(StreamElement stream, double coord)
CoordinateReferenceSystem	getCoordinateReferenceSystem()	Returns the coordinate reference system that describes the location of this map.
StreamAlignmentProps	getDrawProp()
Vector	getElementVector()
WorldRect	getExtent()	Gets the Extent attribute of the MapObjectInterface object
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
StreamJunction	getJunction(int id)
Vector	getJunctionVector()
long	getLastModifiedTime()
MapIdentifier	getMapIdentifier()	Gets the MapIdentifier attribute of the MapObjectInterface object
String	getNextDefaultElementName()
int	getNextLineIndex()
StreamNode	getNode(int id)
Vector	getNodeVector()
StreamElement	getReach(int id)
String	getStreamSegmentsByNodes(Vector nodeVec, Vector ndirVec, Vector segVec)	develops a set of stream segments bounded by the given nodes, also determines whether the nodes are inflow points or outflow points relative to the bounded segments.
void	init()
void	load()	Method to tell the Map Object to load its data into memory
StreamElement	newStreamElement()
StreamJunction	newStreamJunction()
StreamNode	newStreamNode(StreamElement reach)
boolean	readFile(Identifier id)
void	removePropertyChangeListener(PropertyChangeListener listener)
boolean	removeReachFromJunction(String name, boolean upStream)
void	setCoordinateReferenceSystem(CoordinateReferenceSystem system)
void	setExtent(WorldRect rc)	Sets the Extent attribute of the MapObjectInterface object
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
boolean	setLocked(int lockType)
void	setMapIdentifier(MapIdentifier id)	Sets the MapIdentifier attribute of the MapObjectInterface object
void	unload()	Method to tell the Map Object to unload, because the map is done
void	updateJunctionLocations()
boolean	writeFile(Identifier id)
boolean	writeFileGml(Identifier id)

Methods inherited from class hec.lang.NamedType

addModifiableListener, clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface hec.map.MapObjectInterface

getName

Methods inherited from interface hec.map.streamAlignment.StreamAlignmentIfc

addModifiableListener, removeModifiableListener, setModified

Field Details

FILE_NAME

public static final String FILE_NAME

See Also:

• Constant Field Values

Constructor Details

BaseStreamAlignment

public BaseStreamAlignment()

Method Details

init

public void init()

getElementVector

public Vector getElementVector()

Specified by:

getElementVector in interface StreamAlignmentIfc

getNodeVector

public Vector getNodeVector()

Specified by:

getNodeVector in interface StreamAlignmentIfc

getDrawProp

public StreamAlignmentProps getDrawProp()

Specified by:

getDrawProp in interface StreamAlignmentIfc

getJunctionVector

public Vector getJunctionVector()

Specified by:

getJunctionVector in interface StreamAlignmentIfc

newStreamElement

public StreamElement newStreamElement()

Specified by:

newStreamElement in interface StreamAlignmentIfc

newStreamNode

public StreamNode newStreamNode(StreamElement reach)

Specified by:

newStreamNode in interface StreamAlignmentIfc

deleteStreamNode

public void deleteStreamNode(StreamNode node)

Specified by:

deleteStreamNode in interface StreamAlignmentIfc

newStreamJunction

public StreamJunction newStreamJunction()

Specified by:

newStreamJunction in interface StreamAlignmentIfc

findNearestReach

public StreamElement findNearestReach(WorldPt wpt,
 WorldPt wptbest)

finds the stream element nearest the given point. returns the nearest stream element or null ptnbest to the nearest point on the stream

Specified by:

findNearestReach in interface StreamAlignmentIfc

findNearestReach

public StreamElement findNearestReach(WorldPt wpt,
 WorldPt wptbest,
 double[] mindist)

finds the stream element nearest the given point. returns the nearest stream element or null ptnbest to the nearest point on the stream, mindist must have a size of at least 1

Specified by:

findNearestReach in interface StreamAlignmentIfc

findReach

public StreamElement findReach(WorldPt wpt,
 double tol)

Finds a Reach that Contains the given World Point

Specified by:

findReach in interface StreamAlignmentIfc

findReach

public StreamElement findReach(StreamNode node,
 WorldPt wpt,
 double tol)

Finds a reach that contains the given world point but does not have the given node.

findReach

public StreamElement findReach(WorldPt wpt,
 double tol,
 StreamElement rch0)

Finds a Reach that Contains the given World Point for creating reaches

Specified by:

findReach in interface StreamAlignmentIfc

findReach

public StreamElement findReach(String name)

Specified by:

findReach in interface StreamAlignmentIfc

findReach

public StreamElement findReach(int idx)

Specified by:

findReach in interface StreamAlignmentIfc

deleteReach

public boolean deleteReach(int index)

deleteReach

public boolean deleteReach(String name)

Specified by:

deleteReach in interface StreamAlignmentIfc

deleteAll

public boolean deleteAll()

Deletes all elements, nodes, and reaches.

Specified by:

deleteAll in interface StreamAlignmentIfc

getReach

public StreamElement getReach(int id)

Specified by:

getReach in interface StreamAlignmentIfc

getJunction

public StreamJunction getJunction(int id)

Specified by:

getJunction in interface StreamAlignmentIfc

getNode

public StreamNode getNode(int id)

Specified by:

getNode in interface StreamAlignmentNodeIfc

createReach

public StreamElement createReach(StreamPolyLine line,
 double tol)

Specified by:

createReach in interface StreamAlignmentIfc

connectAlignment

public void connectAlignment(double tolerance)

Iterates through the stream alignment connecting the stream elements together.

Specified by:

connectAlignment in interface StreamAlignmentIfc

connectReach

public void connectReach(StreamElement elem,
 double tol)

Specified by:

connectReach in interface StreamAlignmentIfc

connectNode

public boolean connectNode(StreamElement elem,
 StreamNode node,
 double tol)

Specified by:

connectNode in interface StreamAlignmentIfc

unload

public void unload()

Description copied from interface: MapObjectInterface

Method to tell the Map Object to unload, because the map is done

Specified by:

unload in interface MapObjectInterface

readFile

public boolean readFile(Identifier id)

writeFileGml

public boolean writeFileGml(Identifier id)

writeFile

public boolean writeFile(Identifier id)

setMapIdentifier

public void setMapIdentifier(MapIdentifier id)

Description copied from interface: MapObjectInterface

Sets the MapIdentifier attribute of the MapObjectInterface object

Specified by:

setMapIdentifier in interface MapObjectInterface

Parameters:

id - The new MapIdentifier value

getMapIdentifier

public MapIdentifier getMapIdentifier()

Description copied from interface: MapObjectInterface

Gets the MapIdentifier attribute of the MapObjectInterface object

Specified by:

getMapIdentifier in interface MapObjectInterface

Returns:

The MapIdentifier value

setExtent

public void setExtent(WorldRect rc)

Description copied from interface: MapObjectInterface

Sets the Extent attribute of the MapObjectInterface object

Specified by:

setExtent in interface MapObjectInterface

Parameters:

rc - The new Extent value

getExtent

public WorldRect getExtent()

Description copied from interface: MapObjectInterface

Gets the Extent attribute of the MapObjectInterface object

Specified by:

getExtent in interface MapObjectInterface

Returns:

The Extent value

updateJunctionLocations

public void updateJunctionLocations()

Specified by:

updateJunctionLocations in interface StreamAlignmentIfc

findStreamJunction

public StreamJunction findStreamJunction(StreamElement stream,
 WorldPt wpt,
 double tol)

look for the closest stream junction on the given stream near the given point

Specified by:

findStreamJunction in interface StreamAlignmentIfc

findStreamNode

public StreamNode findStreamNode(StreamElement stream,
 WorldPt wpt,
 double tol)

look for a stream node on the given stream near the given point

Specified by:

findStreamNode in interface StreamAlignmentIfc

findNearestStreamNode

public StreamNode findNearestStreamNode(StreamElement stream,
 WorldPt wpt)

Specified by:

findNearestStreamNode in interface StreamAlignmentIfc

findDownstreamNode

public StreamNode findDownstreamNode(StreamElement stream,
 double coord)

Specified by:

findDownstreamNode in interface StreamAlignmentIfc

findUpstreamNode

public StreamNode findUpstreamNode(StreamElement stream,
 double coord)

Specified by:

findUpstreamNode in interface StreamAlignmentIfc

removeReachFromJunction

public boolean removeReachFromJunction(String name,
 boolean upStream)

Specified by:

removeReachFromJunction in interface StreamAlignmentIfc

getStreamSegmentsByNodes

public String getStreamSegmentsByNodes(Vector nodeVec,
 Vector ndirVec,
 Vector segVec)

develops a set of stream segments bounded by the given nodes, also determines whether the nodes are inflow points or outflow points relative to the bounded segments. An error message is returned if the set of nodes do not form a closed pool.

Specified by:

getStreamSegmentsByNodes in interface StreamAlignmentIfc

getNextLineIndex

public int getNextLineIndex()

Specified by:

getNextLineIndex in interface StreamAlignmentIfc

getNextDefaultElementName

public String getNextDefaultElementName()

Specified by:

getNextDefaultElementName in interface StreamAlignmentIfc

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class NamedType

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class NamedType

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful

setLocked

public boolean setLocked(int lockType)

Specified by:

setLocked in interface StreamAlignmentIfc

load

public void load()
          throws IOException

Description copied from interface: MapObjectInterface

Method to tell the Map Object to load its data into memory

Specified by:

load in interface MapObjectInterface

Throws:

IOException - Description of Exception

getLastModifiedTime

public long getLastModifiedTime()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface StreamAlignmentIfc

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface StreamAlignmentIfc

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(CoordinateReferenceSystem system)

Specified by:

setCoordinateReferenceSystem in interface StreamAlignmentIfc

getCoordinateReferenceSystem

public CoordinateReferenceSystem getCoordinateReferenceSystem()

Description copied from interface: MapObjectInterface

Returns the coordinate reference system that describes the location of this map. Users can return NULL if they don't have CoordinateReferenceSystem.

Specified by:

getCoordinateReferenceSystem in interface MapObjectInterface

Returns: