SAIF.Framework.Common.Files API reference¶
This page lists all public types exposed by SAIF.Framework.Common.Files. Each type links to its full API reference page.
Types¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| FileFormats | Enum | SAIF.Common.Files |
Declares the four supported (plus one unimplemented) flat-file layout formats used to select a parsing/writing strategy. |
| FileDelimiters | Static class | SAIF.Common.Files |
Centralizes the comma and tab delimiter literals used by the CSV/TabDelimited format attributes. |
| IFileConfiguration | Interface | SAIF.Common.Files |
The resolved runtime layout contract consumed by FileReader<TRecord>/FileWriter<TRecord>. |
| IParser<T> | Interface | SAIF.Common.Files |
The minimal shared parsing contract coupling the flat-file and EDI parsing subsystems. |
| FileReader | Static class | SAIF.Common.Files.Core |
Reads a whole file into raw untyped Record/TabDelimitedRecord rows without a configuration. |
| FileReader<TRecord> | Static generic class | SAIF.Common.Files.Core |
Attribute/configuration-driven typed flat-file reader. |
| FileWriter<TRecord> | Static generic class | SAIF.Common.Files.Core |
Attribute/configuration-driven typed flat-file writer. |
| Record | Class | SAIF.Common.Files.Core |
Raw-line record model bound directly for whole-line record types. |
| TabDelimitedRecord | Class | SAIF.Common.Files.Core |
Tab-delimited row model that lazily splits its Value into Field items. |
| Field | Class | SAIF.Common.Files.Core |
An individual delimited-field value and its ordinal position within a TabDelimitedRecord. |
| IRecord | Interface | SAIF.Common.Files.Core |
Contract implemented by Record, satisfied by any type wanting raw-line binding. |
| IDelimitedRecord | Interface | SAIF.Common.Files.Core |
Contract implemented by TabDelimitedRecord for delimited row access via GetChildValue. |
| IField | Interface | SAIF.Common.Files.Core |
Contract implemented by Field. |
| FormatBase | Abstract attribute class | SAIF.Common.Files.Core.Attributes |
Base attribute carrying format-level metadata for concrete format attributes. |
| Csv | Attribute class | SAIF.Common.Files.Core.Attributes |
Declares CSV format with comma delimiter and quoted-field handling. |
| TabDelimited | Attribute class | SAIF.Common.Files.Core.Attributes |
Declares tab-delimited format. |
| DelimitedBy | Attribute class | SAIF.Common.Files.Core.Attributes |
Declares a custom-delimiter format with an explicit delimiter. |
| FixedFormat | Attribute class | SAIF.Common.Files.Core.Attributes |
Declares fixed-width format driving position/length-based layout. |
| DelimitedLayout | Attribute class | SAIF.Common.Files.Core.Attributes |
Maps a property to a 1-based delimited element ordinal. |
| FixedLayout | Attribute class | SAIF.Common.Files.Core.Attributes |
Maps a property to a fixed-width position/length pair. |
| FileConfiguration | Class | SAIF.Common.Files.Core.Configurations |
Non-generic runtime layout model populated by attribute discovery. |
| FileConfiguration<T> | Generic class | SAIF.Common.Files.Core.Configurations |
Code-first fluent alternative to attribute-based configuration. |
| FileRecordLayout | Class | SAIF.Common.Files.Core.Configurations |
Per-property layout record consumed by the reader and writer. |
| FileLayoutBuilder | Class | SAIF.Common.Files.Core.Configurations |
Fluent chained builder for configuring a single FileRecordLayout. |
| IFileLayoutBuilder | Interface | SAIF.Common.Files.Core.Configurations |
Contract for the fluent layout builder API. |
| EdiManager | Class | SAIF.Common.Files.Edi |
The sanctioned facade entry point for reading/writing EDI interchange files via File()'s fluent builder. |
| EdiFile | Class | SAIF.Common.Files.Edi |
The root domain object for a parsed/constructed EDI interchange; owns the flat segment list and lazily builds the functional-group hierarchy. |
| EdiSegment | Class | SAIF.Common.Files.Edi |
The untyped in-memory representation of one X12 segment, consumed by typed segment Fill()/Parse() methods. |
| EdiElement | Abstract class | SAIF.Common.Files.Edi |
Shared base for EdiSegment, EdiDataElement, and EdiCompositeDataElement, carrying ordinal position, raw value, and element kind. |
| EdiDataElement | Class | SAIF.Common.Files.Edi |
A simple (non-composite) X12 data element, serialized with a trailing asterisk delimiter. |
| EdiCompositeDataElement | Class | SAIF.Common.Files.Edi |
A composite X12 data element containing colon-separated sub-elements. |
| EdiRecordBase | Class | SAIF.Common.Files.Edi |
Shared base supplying the three X12 delimiter characters and a sequential index generator to parsers/builders. |
| SegmentGroup | Class | SAIF.Common.Files.Edi |
The base grouping unit produced by EdiGroupParser.ParseSegmentGroup, keyed by a control-number value. |
| GroupContainer | Class | SAIF.Common.Files.Edi |
Extends SegmentGroup with an explicit header/trailer pair and a member-only Segments collection. |
| FunctionalGroup | Class | SAIF.Common.Files.Edi |
Represents one X12 functional group (GS/GE), keyed by GS06. |
| FunctionalGroupContainer | Class | SAIF.Common.Files.Edi |
The top-level collection type returned by EdiFile.FunctionalGroups. |
| TransactionSet | Class | SAIF.Common.Files.Edi |
Represents one X12 transaction set (ST/SE), keyed by ST02. |
| TransactionSetContainer | Class | SAIF.Common.Files.Edi |
Collection type held by FunctionalGroup.TransactionSets. |
| HierarchialTransaction | Class | SAIF.Common.Files.Edi |
Represents one BHT-rooted hierarchical transaction, nesting HierarchialLevel objects. |
| HierarchialTransactionContainer | Class | SAIF.Common.Files.Edi |
Collection type held by TransactionSet.HierarchialTransactions. |
| HierarchialLevel | Class | SAIF.Common.Files.Edi |
Represents one HL-rooted hierarchical level nested within a HierarchialTransaction. |
| NameBuilder | Class | SAIF.Common.Files.Edi |
Generates outbound EDI file names in a fixed timestamped pattern. |
| Delimiters | Static class | SAIF.Common.Files.Edi |
Publicly-accessible constant duplicates of the three X12 delimiter characters. |
| IEdiFile | Interface | SAIF.Common.Files.Edi |
Contract implemented by EdiFile. |
| IEdiSegment | Interface | SAIF.Common.Files.Edi |
Contract implemented by EdiSegment. |
| IEdiElement | Interface | SAIF.Common.Files.Edi |
Shared contract for every parsed EDI element kind. |
| IEdiCompositeDataElement | Interface | SAIF.Common.Files.Edi |
Contract implemented by EdiCompositeDataElement. |
| IEdiDataElement | Interface | SAIF.Common.Files.Edi |
Contract implemented by EdiDataElement (and EdiCompositeDataElement). |
| IEdiEntity | Interface | SAIF.Common.Files.Edi |
Declared but not referenced by any live code in this library — a reserved/unused contract. |
| ISegmentGroup | Interface | SAIF.Common.Files.Edi |
Contract implemented by SegmentGroup. |
| IFunctionalGroup | Interface | SAIF.Common.Files.Edi |
Contract implemented by FunctionalGroup. |
| ITransactionSet | Interface | SAIF.Common.Files.Edi |
Contract implemented by TransactionSet. |
| IHierarchialTransaction | Interface | SAIF.Common.Files.Edi |
Contract implemented by HierarchialTransaction. |
| IHierarchialLevel | Interface | SAIF.Common.Files.Edi |
Contract implemented by HierarchialLevel. |
| ElementType | Enum | SAIF.Common.Files.Edi |
Classifies an EdiElement as a segment, simple data element, or composite data element. |
| Areas | Enum | SAIF.Common.Files.Edi |
Declared but not referenced by any live code in this library — reserved/unused. |
| RequirementDesignator | Enum | SAIF.Common.Files.Edi |
Declared but not referenced by any live code — reserved/unused. |
| RelationalCondition | Enum | SAIF.Common.Files.Edi |
Declared but not referenced by any live code — reserved/unused. |
| DataElementType | Enum | SAIF.Common.Files.Edi |
Declared but not referenced by any live code — reserved/unused. |
| SegmentGroupType | Enum | SAIF.Common.Files.Edi |
Declared but not referenced by any live code — reserved/unused. |
| EdiFileBuilder | Class | SAIF.Common.Files.Edi.Core.Builders |
Fluent builder returned by EdiManager.File() that stages a file path and delegates to EdiFileReader/EdiFileWriter. |
| IEdiFileBuilder | Interface | SAIF.Common.Files.Edi.Core.Builders |
Contract implemented by EdiFileBuilder for the fluent path/read/write API. |
| EdiRecordBuilder | Static class | SAIF.Common.Files.Edi.Core.Builders |
Sole serializer from ordered data elements to X12 text for segments, simple elements, and composite elements. |
| SegmentBuilder | Class | SAIF.Common.Files.Edi.Core.Builders |
Assembles the ordered element collection for one X12 segment, enforcing identifying-element and composite-parent rules. |
| ISegmentBuilder | Interface | SAIF.Common.Files.Edi.Core.Builders |
Contract implemented by SegmentBuilder for element-add and build operations. |
| IDataElementBuilder | Interface | SAIF.Common.Files.Edi.Core.Builders |
Declared but unreferenced Add-only element-registration contract. |
| EdiSegmentParser | Class | SAIF.Common.Files.Edi.Core.Parsers |
Splits a raw EDI interchange string into segment tokens and builds the ordered IEdiSegment list. |
| EdiDataElementParser | Class | SAIF.Common.Files.Edi.Core.Parsers |
Splits a segment token into simple and composite data elements. |
| EdiCompositeDataElementParser | Class | SAIF.Common.Files.Edi.Core.Parsers |
Splits a composite-element token into its child data elements. |
| EdiGroupParser | Static class | SAIF.Common.Files.Edi.Core.Parsers |
Converts a flat segment list into functional groups, transaction sets, and hierarchical transactions/levels. |
| EdiFileReader | Class | SAIF.Common.Files.Edi.Core.Readers |
Loads a physical EDI file, joins its lines, and parses it into a populated EdiFile. |
| EdiFileWriter | Class | SAIF.Common.Files.Edi.Core.Writers |
Serializes an IEdiFile's ordered segments to a single-line physical EDI file. |
| DateMaker | Static class | SAIF.Common |
Converts EDI date/time strings to/from DateTime for date-bearing segments. |
| ISegmentData | Interface | SAIF.Common.Files.Edi.Segments |
The uniform contract (SegmentId, Build(), Fill()) implemented by all 43 typed X12 segment classes for symmetric object-to-segment mapping. |
| SvSegmentBase | Abstract class | SAIF.Common.Files.Edi.Segments |
Shared base for SV1/SV2/SV3 service-line segments, building/filling the composite procedure-code element common to all three. |
| CompositeProcedureCodeElement | Class | SAIF.Common.Files.Edi.Segments |
The composite procedure-code value shared by SV1/SV2/SV3/SVC segments, with equality that excludes the description field. |
| Ak1Segment | Class | SAIF.Common.Files.Edi.Segments |
AK1 functional group response header, identifying the acknowledged functional group. |
| Ak2Segment | Class | SAIF.Common.Files.Edi.Segments |
AK2 transaction set response header, with the control number zero-padded to four digits. |
| Ak9Segment | Class | SAIF.Common.Files.Edi.Segments |
AK9 functional group response trailer summarizing accepted/received transaction set counts. |
| AmtSegment | Class | SAIF.Common.Files.Edi.Segments |
AMT monetary amount segment carrying a qualified dollar amount. |
| BhtSegment | Class | SAIF.Common.Files.Edi.Segments |
BHT beginning-of-hierarchical-transaction header with an original/reissue flag. |
| BprSegment | Class | SAIF.Common.Files.Edi.Segments |
BPR financial information segment carrying the 835 payment order and banking details. |
| CasSegment | Class | SAIF.Common.Files.Edi.Segments |
CAS claim adjustment segment carrying repeating reason-code/amount adjustment triplets. |
| Cl1Segment | Class | SAIF.Common.Files.Edi.Segments |
CL1 institutional claim code segment carrying the admission type. |
| ClpSegment | Class | SAIF.Common.Files.Edi.Segments |
CLP claim-level data segment header for each claim in an 835 remittance. |
| CtxSegment | Class | SAIF.Common.Files.Edi.Segments |
CTX context/adjustment segment with amounts scaled to cents. |
| DmgSegment | Class | SAIF.Common.Files.Edi.Segments |
DMG demographic information segment (inbound-only) carrying birth date and gender. |
| DtmSegment | Class | SAIF.Common.Files.Edi.Segments |
DTM date/time reference segment attaching a qualified date to a claim/loop. |
| DtpSegment | Class | SAIF.Common.Files.Edi.Segments |
DTP date/time period segment with format-dependent date/range parsing. |
| GeSegment | Class | SAIF.Common.Files.Edi.Segments |
GE functional group trailer closing out a GS group. |
| GsSegment | Class | SAIF.Common.Files.Edi.Segments |
GS functional group header with a fixed responsible agency code and batch date/time. |
| HiSegment | Class | SAIF.Common.Files.Edi.Segments |
HI health care diagnosis code segment (inbound-only) carrying repeating diagnosis codes. |
| HlSegment | Class | SAIF.Common.Files.Edi.Segments |
HL hierarchical level segment establishing parent/child loop relationships. |
| IeaSegment | Class | SAIF.Common.Files.Edi.Segments |
IEA interchange trailer with a fixed nine-digit control number. |
| Ik3Segment | Class | SAIF.Common.Files.Edi.Segments |
IK3 implementation acknowledgement segment-level error. |
| Ik4Segment | Class | SAIF.Common.Files.Edi.Segments |
IK4 implementation acknowledgement data-element error. |
| Ik5Segment | Class | SAIF.Common.Files.Edi.Segments |
IK5 transaction set response trailer with Acknowledgement()/Reject() factories. |
| IsaSegment | Class | SAIF.Common.Files.Edi.Segments |
ISA interchange header with fixed qualifiers, padding, and acknowledgement request flag. |
| LinSegment | Class | SAIF.Common.Files.Edi.Segments |
LIN item identification segment carrying a coded item identifier. |
| LqSegment | Class | SAIF.Common.Files.Edi.Segments |
LQ form identification code segment carrying a coded remark reference. |
| LxSegment | Class | SAIF.Common.Files.Edi.Segments |
LX transaction set line number segment numbering a repeating group. |
| N1Segment | Class | SAIF.Common.Files.Edi.Segments |
N1 party identification segment naming a party within a loop. |
| N3Segment | Class | SAIF.Common.Files.Edi.Segments |
N3 party location segment carrying street address lines. |
| N4Segment | Class | SAIF.Common.Files.Edi.Segments |
N4 party geographic location segment splitting a postal code into zip and extension. |
| Nm1Segment | Class | SAIF.Common.Files.Edi.Segments |
NM1 individual/organizational name segment with person-vs-organization layout. |
| PerSegment | Class | SAIF.Common.Files.Edi.Segments |
PER administrative communications contact segment. |
| PrvSegment | Class | SAIF.Common.Files.Edi.Segments |
PRV provider information segment carrying role and taxonomy codes. |
| PwkSegment | Class | SAIF.Common.Files.Edi.Segments |
PWK paperwork segment describing supporting documentation. |
| QtySegment | Class | SAIF.Common.Files.Edi.Segments |
QTY quantity segment carrying a qualified numeric quantity. |
| RefSegment | Class | SAIF.Common.Files.Edi.Segments |
REF reference identification segment carrying a qualified cross-reference identifier. |
| SeSegment | Class | SAIF.Common.Files.Edi.Segments |
SE transaction set trailer with a zero-padded control number. |
| StcSegment | Class | SAIF.Common.Files.Edi.Segments |
STC claim status segment used in 277 claim status transactions. |
| StSegment | Class | SAIF.Common.Files.Edi.Segments |
ST transaction set header with a zero-padded control number. |
| Sv1Segment | Class | SAIF.Common.Files.Edi.Segments |
SV1 professional service line segment (inbound-only) with an emergency indicator. |
| Sv2Segment | Class | SAIF.Common.Files.Edi.Segments |
SV2 institutional service line segment (inbound-only). |
| Sv3Segment | Class | SAIF.Common.Files.Edi.Segments |
SV3 dental service line segment (inbound-only). |
| SvcSegment | Class | SAIF.Common.Files.Edi.Segments |
SVC professional service adjudication segment with billed-vs-adjudicated suppression rules. |
| TooSegment | Class | SAIF.Common.Files.Edi.Segments |
TOO tooth surface/status segment for dental claims. |
| TrnSegment | Class | SAIF.Common.Files.Edi.Segments |
TRN trace number segment correlating a transaction to its originating record. |
Sources¶
- Common\SAIF.Common.Files\SAIF.Framework.Common.Files.csproj