com.partnersoft.formats.dxf

Class DxfGroupReader

java.lang.Object

com.partnersoft.io.AbstractIterableInput<DxfGroup>

com.partnersoft.formats.dxf.DxfGroupReader

All Implemented Interfaces:

IterableInput<DxfGroup>, java.lang.Iterable<DxfGroup>

public class DxfGroupReader
extends AbstractIterableInput<DxfGroup>

Reads individual group items from a DXF file. Copyright 2006 Partner Software, Inc.

Author:

Paul Reavis

See Also:

DxfGroup

Nested Class Summary

Nested classes/interfaces inherited from interface com.partnersoft.io.IterableInput

IterableInput.Status

Constructor Summary

Constructors

Constructor and Description
DxfGroupReader(VfsFile file)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeImp() Subclass implementation of guts of close() method.
protected boolean	fetchImp() Subclass implementation of guts of fetch() method.
int	getCurrentLineNumber() Returns the line number the current group starts on.
DxfGroup	getFetched() Returns the last fetched item (if immutable) or a copy of it (if mutable).
protected void	openImp() Subclass implementation of guts of open() method.
java.util.List<DxfGroup>	readAll() Reads all remaining groups in the file.
java.util.List<DxfGroup>	readAll(java.util.List<DxfGroup> results) Reads all remaining groups in the file and appends them to the provided list.
DxfGroup	readGroup() Reads a single DxfGroup from the input.
java.util.List<DxfGroup>	readGroups(int count) Reads up to the listed number of DXFGroups from the input.
java.util.List<DxfGroup>	readGroups(int count, java.util.List<DxfGroup> results) Reads up to the listed number of DXFGroups from the input, appending them to the given results list.
java.util.List<DxfGroup>	readUntilCode(java.util.List<DxfGroup> results, int code) Reads groups until it sees one that with the given code.
java.util.List<DxfGroup>	readUntilMatch(java.util.List<DxfGroup> results, int code, java.lang.String value) Reads groups until it sees one that matches the given code and value.
boolean	scanForGroup(DxfGroup group) Scans the file for the given group pattern, discarding intervening groups.
boolean	scanForGroups(DxfGroup group1, DxfGroup group2) Scans the file for the given pair of groups, discarding intervening groups.
boolean	scanForGroups(int code, java.lang.String value)
java.lang.String	toString()

Methods inherited from class com.partnersoft.io.AbstractIterableInput

close, fetch, getException, getStatus, isFetchValid, iterator, open

Methods inherited from class java.lang.Object

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

Constructor Detail

DxfGroupReader

public DxfGroupReader(VfsFile file)
               throws java.io.IOException

Throws:

java.io.IOException

Method Detail

openImp

protected void openImp()
                throws java.lang.Exception

Description copied from class: AbstractIterableInput

Subclass implementation of guts of open() method.

Subclasses must implement this to do the actual work required by open(). Feel free to throw exceptions; these are caught inside the open() itself and applied to the exception variable. Thus, you can focus on the actual task instead of paperwork.

Specified by:

openImp in class AbstractIterableInput<DxfGroup>

Throws:

java.lang.Exception

fetchImp

protected boolean fetchImp()
                    throws java.lang.Exception

Description copied from class: AbstractIterableInput

Subclass implementation of guts of fetch() method.

Subclasses must implement this to do the actual work required by fetch(). Feel free to throw exceptions; these are caught inside the fetch() itself and applied to the exception variable. Thus, you can focus on the actual task instead of paperwork.

Specified by:

fetchImp in class AbstractIterableInput<DxfGroup>

Returns:

true if fetch successful

Throws:

java.lang.Exception

closeImp

protected void closeImp()
                 throws java.lang.Exception

Description copied from class: AbstractIterableInput

Subclass implementation of guts of close() method.

Subclasses must implement this to do the actual work required by close(). Feel free to throw exceptions; these are caught inside the close() itself and applied to the exception variable. Thus, you can focus on the actual task instead of paperwork.

Specified by:

closeImp in class AbstractIterableInput<DxfGroup>

Throws:

java.lang.Exception

getFetched

public DxfGroup getFetched()

Description copied from interface: IterableInput

Returns the last fetched item (if immutable) or a copy of it (if mutable). Note that this means multiple calls to getFetched() may return different objects for the same fetch, but that the return value is always safe to share since modifying it won't affect the IterableInput's internal state.

The last fetched item is that loaded by the most recent call to fetch().

Implementations may prefer to instantiate this lazily; in other words, the underlying IterableInput may know that it has a valid fetch (e.g. loaded the characters for a String into an internal buffer) but may not have created this object yet (e.g. created a new String with the characters from the buffer). This allows skipping items without instantiating them, or accessing the underlying state without instantiating an actual item.

Implementations may also wish to provide unsafe access to the fetched item via other methods or public variables. The requirement that a safe copy be returned does prevent object reuse or other optimizations with this method, so feel free to use other means to provide a high-performance alternative.

This method may only be called when the input is in the FETCHING status. Calling it from any other status will result in an IllegalStateException.

Returns:

object representing the most recent fetch

readGroup

public DxfGroup readGroup()
                   throws java.io.IOException

Reads a single DxfGroup from the input. Returns null if there are no more (end of file).

Throws:

java.io.IOException - if unable to read the input

java.io.EOFException - if EOF occurs in middle of group read

readGroups

public java.util.List<DxfGroup> readGroups(int count)
                                    throws java.io.IOException

Reads up to the listed number of DXFGroups from the input. Returns a list continuing that number of groups, or the number remaining in the file; whichever is fewer.

Parameters:

count - number of groups to attempt read

Returns:

list of groups read

Throws:

java.io.IOException - if unable to read the input

java.io.EOFException - if EOF occurs in the middle of a group read

readGroups

public java.util.List<DxfGroup> readGroups(int count,
                                  java.util.List<DxfGroup> results)
                                    throws java.io.IOException

Reads up to the listed number of DXFGroups from the input, appending them to the given results list. Returns the same results list (mostly for convenience and consistency with the other readGroups() method). This allows you to continue adding to the same list, or to supply a specific list implementation.

Parameters:

count - number of groups to attempt read

results - list to append read groups to

Returns:

list of groups read

Throws:

java.io.IOException - if unable to read the input

java.io.EOFException - if EOF occurs in the middle of a group read

readUntilMatch

public java.util.List<DxfGroup> readUntilMatch(java.util.List<DxfGroup> results,
                                      int code,
                                      java.lang.String value)
                                        throws java.io.IOException

Reads groups until it sees one that matches the given code and value. Does not include the matched one; you can read it via readGroup() or look at it via getFetched().

Parameters:

results -

code -

value -

Returns:

Throws:

java.io.IOException

readUntilCode

public java.util.List<DxfGroup> readUntilCode(java.util.List<DxfGroup> results,
                                     int code)
                                       throws java.io.IOException

Reads groups until it sees one that with the given code. Does not include the matched one; you can read it via readGroup() or look at it via getFetched().

Parameters:

results -

code -

Returns:

Throws:

java.io.IOException

readAll

public java.util.List<DxfGroup> readAll()
                                 throws java.io.IOException

Reads all remaining groups in the file. Returns them as a big list. Beware of doing this to large files!

Returns:

list of all remaining groups in the file

Throws:

java.io.IOException - if it can't read them for some reason

readAll

public java.util.List<DxfGroup> readAll(java.util.List<DxfGroup> results)
                                 throws java.io.IOException

Reads all remaining groups in the file and appends them to the provided list. Returns the provided list (for convenience and consistency with readAll()). Beware of doing this to large files!

Parameters:

results - list to append groups to

Returns:

same list provided as parameter

Throws:

java.io.IOException - if it can't read them for some reason

getCurrentLineNumber

public int getCurrentLineNumber()

Returns the line number the current group starts on. This is the line that the group's code is on; the value will be on the next line. Note that if you started this DxfGroupReader with a Reader at anywhere other than the beginning of the file you'll get a wrong line number.

Returns:

line number of current group

scanForGroup

public boolean scanForGroup(DxfGroup group)

Scans the file for the given group pattern, discarding intervening groups. Leaves the DxfGroupReader in a state such that getFetched() will return the matching group, or at the end of the file if none was found. Returns true if found.

scanForGroups

public boolean scanForGroups(int code,
                    java.lang.String value)

scanForGroups

public boolean scanForGroups(DxfGroup group1,
                    DxfGroup group2)

Scans the file for the given pair of groups, discarding intervening groups. Leaves the DxfGroupReader in a state such that getFetched() will return the latter of the two groups.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object