Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.DConRefRecord

DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation. Represents a DConRef Structure [MS-XLS s. 2.4.86], and the contained DConFile structure [MS-XLS s. 2.5.69]. This in turn contains a XLUnicodeStringNoCch [MS-XLS s. 2.5.296].

         _______________________________
        |          DConRef              |
(bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
        |    ref    |cch|  stFile   | un|
        +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
                              |
                     _________|_____________________
                    |DConFile / XLUnicodeStringNoCch|
                    +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
             (bits) |h|   reserved  |      rgb      |
                    +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+

Where

DConFile.h = 0x00 if the characters inrgb are single byte, and DConFile.h = 0x01 if they are double byte.
If they are double byte, then
- If it exists, the length of DConRef.un = 2. Otherwise it is 1.
- The length of DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to DConRef.cch.
DConRef.rgb starts with 0x01 if it is an external reference, and with 0x02 if it is a self-reference.

At the moment this class is read-only.

Field Summary

Modifier and Type	Field and Description
private byte[]	_unused unused bits at the end, must be set to 0.
private final int	charCount the number of chars in the link
private final int	charType the type of characters (single or double byte)
private final int	firstCol
private final int	firstRow A RefU structure specifying the range of cells if this record is part of an SXTBL.
private final int	lastCol
private final int	lastRow
private final byte[]	path The link's path string.
public static final short	sid The id of the record type, `sid =`

Constructor Summary

Access	Constructor and Description
public	DConRefRecord(DConRefRecord other)
public	DConRefRecord(byte[] byte array containing a DConRef Record, including the header. data) Read constructor.
public	DConRefRecord(RecordInputStream RecordInputStream containing a DConRefRecord structure. inStream) Read Constructor.

Method Summary

Modifier and Type	Method and Description
private static RecordInputStream	bytesToRIStream(byte[] data)
public DConRefRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public int	Returns: The first column of the range. getFirstColumn()
public int	Returns: The first row of the range. getFirstRow()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public int	Returns: The last column of the range. getLastColumn()
public int	Returns: The last row of the range. getLastRow()
public byte[]	Returns: raw path byte array. getPath()
public String	Returns: the link's path, with the special characters stripped/replaced. May be null. See MS-XLS 2.5.277 (VirtualPath) getReadablePath()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public boolean	Returns: true iff this is an external reference. isExternalRef() Checks if the data source in this reference record is external to this sheet or internal.
protected void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_unused	back to summary
private byte[] _unused unused bits at the end, must be set to 0.

charCount	back to summary
private final int charCount the number of chars in the link

charType	back to summary
private final int charType the type of characters (single or double byte)

firstCol	back to summary
private final int firstCol

firstRow	back to summary
private final int firstRow A RefU structure specifying the range of cells if this record is part of an SXTBL. [MS XLS s.2.5.211]

lastCol	back to summary
private final int lastCol

lastRow	back to summary
private final int lastRow

path back to summary

path	back to summary
private final byte[] path The link's path string. This is the `rgb` field of a `XLUnicodeStringNoCch`. Therefore it will contain at least one leading special character (0x01 or 0x02) and probably other ones. See Also DConFile [MS-XLS s. 2.5.77] and VirtualPath [MS-XLS s. 2.5.69]

private final byte[] path

The link's path string. This is the rgb field of a XLUnicodeStringNoCch. Therefore it will contain at least one leading special character (0x01 or 0x02) and probably other ones.

See Also: DConFile [MS-XLS s. 2.5.77] and VirtualPath [MS-XLS s. 2.5.69]

sid	back to summary
public static final short sid The id of the record type, `sid =`

Constructor Detail

DConRefRecord	back to summary
public DConRefRecord(DConRefRecord other)

DConRefRecord	back to summary
public DConRefRecord(byte[] data) Read constructor. Parameters data:byte[] byte array containing a DConRef Record, including the header.

DConRefRecord

back to summary

public DConRefRecord(byte[] data)

Read constructor.

Parameters

data:byte[]: byte array containing a DConRef Record, including the header.

DConRefRecord	back to summary
public DConRefRecord(RecordInputStream inStream) Read Constructor. Parameters inStream:RecordInputStream RecordInputStream containing a DConRefRecord structure.

DConRefRecord

back to summary

public DConRefRecord(RecordInputStream inStream)

Read Constructor.

Parameters

inStream:RecordInputStream: RecordInputStream containing a DConRefRecord structure.

Method Detail

bytesToRIStream	back to summary
private static RecordInputStream bytesToRIStream(byte[] data)

copy	back to summary
public DConRefRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:DConRefRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public DConRefRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:DConRefRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize. Annotations @Override

getDataSize

back to summary

protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations

@Override

getFirstColumn	back to summary
public int getFirstColumn() Returns:int The first column of the range.

getFirstRow	back to summary
public int getFirstRow() Returns:int The first row of the range.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getLastColumn	back to summary
public int getLastColumn() Returns:int The last column of the range.

getLastRow	back to summary
public int getLastRow() Returns:int The last row of the range.

getPath	back to summary
public byte[] getPath() Returns:byte[] raw path byte array.

getReadablePath	back to summary
public String getReadablePath() Returns:String the link's path, with the special characters stripped/replaced. May be null. See MS-XLS 2.5.277 (VirtualPath)

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record Annotations @Override

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations

@Override

isExternalRef	back to summary
public boolean isExternalRef() Checks if the data source in this reference record is external to this sheet or internal. Returns:boolean true iff this is an external reference.

isExternalRef

back to summary

public boolean isExternalRef()

Checks if the data source in this reference record is external to this sheet or internal.

Returns:boolean: true iff this is an external reference.

serialize back to summary

serialize	back to summary
protected void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass. The number of bytes written must equal the record size reported by `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object Annotations @Override

protected void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

Annotations

@Override

public Class DConRefRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail