Module jonix.common
Package com.tectonica.jonix.common

Interface OnixElement<V>

All Superinterfaces:
OnixTag
All Known Implementing Classes:
AbbreviatedLength, AddresseeIDType, AddresseeIDType, AddresseeName, Affiliation, Affiliation, AffiliationIDType, AgentIDType, AgentIDType, AgentName, AgentName, AgentRole, AgentRole, AlternativeFormatEAN13, AlternativeFormatISBN, AlternativeProductEAN13, AlternativeProductISBN, AncillaryContentDescription, AncillaryContentType, Annotation, AnnouncementDate, AudienceCode, AudienceCodeType, AudienceCodeType, AudienceCodeTypeName, AudienceCodeTypeName, AudienceCodeValue, AudienceCodeValue, AudienceDescription, AudienceDescription, AudienceHeadingText, AudienceRangePrecision, AudienceRangePrecision, AudienceRangeQualifier, AudienceRangeQualifier, AudienceRangeValue, AudienceRangeValue, AudienceRestrictionFlag, AudienceRestrictionNote, AvailabilityCode, AVDuration, AVItemIDType, AVItemType, AwardingBody, Barcode, BarcodeType, BASICMainSubject, BASICVersion, BatchQuantity, BatchQuantity, BibleContents, BibleContents, BiblePurpose, BiblePurpose, BibleReferenceLocation, BibleReferenceLocation, BibleTextFeature, BibleTextFeature, BibleTextOrganization, BibleTextOrganization, BibleVersion, BibleVersion, BICDiscountGroupCode, BICMainSubject, BICVersion, BiographicalNote, BiographicalNote, BookClubAdoption, BookClubAdoption, BookFormDetail, CBO, CBO, CitationNote, CitedContentType, CityOfPublication, CityOfPublication, ClassOfTrade, CollectionElementLevel, CollectionFrequency, CollectionIDType, CollectionSequenceNumber, CollectionSequenceType, CollectionSequenceTypeName, CollectionType, ComplexityCode, ComplexityCode, ComplexitySchemeIdentifier, ComplexitySchemeIdentifier, ComponentNumber, ComponentNumber, ComponentTypeName, ComponentTypeName, ConferenceAcronym, ConferenceDate, ConferenceDescription, ConferenceName, ConferenceNumber, ConferencePlace, ConferenceRole, ConferenceSponsorIDType, ConferenceTheme, ContactName, ContentAudience, ContentDateRole, ContributorDateRole, ContributorDescription, ContributorDescription, ContributorPlaceRelator, ContributorRole, ContributorRole, ContributorStatement, ContributorStatement, CopiesSold, CopiesSold, CopublisherName, CopyrightOwnerIDType, CopyrightOwnerIDType, CopyrightStatementText, CopyrightType, CopyrightYear, CopyrightYear, CorporateBodyAsSubject, CorporateName, CorporateName, CorporateNameInverted, CountriesExcluded, CountriesIncluded, CountryCode, CountryCode, CountryExcluded, CountryOfManufacture, CountryOfPublication, CountryOfPublication, CoverImageFormatCode, CoverImageLink, CoverImageLinkTypeCode, CurrencyCode, CurrencyCode, Date, Date, DateFormat, DefaultClassOfTrade, DefaultCurrencyCode, DefaultCurrencyCode, DefaultLanguageOfText, DefaultLanguageOfText, DefaultLinearUnit, DefaultPriceType, DefaultPriceTypeCode, DefaultWeightUnit, DeletionCode, DeletionText, DeletionText, Dimensions, DiscountAmount, DiscountCode, DiscountCode, DiscountCodeType, DiscountCodeType, DiscountCodeTypeName, DiscountCodeTypeName, DiscountPercent, DiscountPercent, DiscountType, DistinctiveTitle, DOI, DownloadCaption, DownloadCopyrightNotice, DownloadCredit, DownloadTerms, EAN13, EAN13OfSet, EditionNumber, EditionNumber, EditionStatement, EditionStatement, EditionType, EditionTypeCode, EditionVersionNumber, EditionVersionNumber, EmailAddress, EmailAddress, EndDate, EndDate, EndTime, EpubFormat, EpubFormatDescription, EpubFormatVersion, EpubLicenseDateRole, EpubLicenseExpressionLink, EpubLicenseExpressionType, EpubLicenseExpressionTypeName, EpubLicenseName, EpubSource, EpubSourceDescription, EpubSourceVersion, EpubTechnicalProtection, EpubType, EpubTypeDescription, EpubTypeNote, EpubTypeVersion, EpubUsageStatus, EpubUsageType, EpubUsageUnit, EventAcronym, EventDate, EventDescription, EventIDType, EventName, EventNumber, EventPlace, EventRole, EventSponsorIDType, EventStatus, EventTheme, EventType, ExpectedDate, ExpectedDate, ExpectedShipDate, ExtentType, ExtentType, ExtentUnit, ExtentUnit, ExtentValue, ExtentValue, ExtentValueRoman, FaxNumber, FaxNumber, FeatureNote, FeatureValue, FirstPageNumber, FirstPageNumber, FormerTitle, FreeQuantity, FreeQuantity, FromCompany, FromEANNumber, FromEmail, FromLanguage, FromPerson, FromSAN, FundingIDType, Height, IDTypeName, IDTypeName, IDValue, IDValue, Illustrated, IllustrationsNote, IllustrationsNote, IllustrationType, IllustrationTypeDescription, ImageResolution, ImprintIDType, ImprintName, ImprintName, ImprintNameInverted, InitialPrintRun, InitialPrintRun, InsertPointType, InsertPointValue, InterestAge, IntermediaryAvailabilityCode, ISBN, ISBNOfSet, ISMN, ItemNumberWithinSet, ItemQuantity, KeyNames, KeyNames, LanguageCode, LanguageCode, LanguageOfText, LanguageRole, LanguageRole, LastDateForReturns, LastPageNumber, LastPageNumber, LatestReprintNumber, LettersAfterNames, LettersAfterNames, LevelSequenceNumber, LevelSequenceNumber, ListName, LocationIDType, LocationIDType, LocationName, LocationName, MainDescription, MainSubjectSchemeIdentifier, MapScale, MapScale, MarketCountry, MarketCountryExcluded, MarketDateRole, MarketDateRole, MarketPublishingStatus, MarketPublishingStatus, MarketPublishingStatusNote, MarketReference, MarketRestrictionDetail, MarketTerritory, Measurement, Measurement, MeasureType, MeasureTypeCode, MeasureUnitCode, MeasureUnitCode, MediaFileDate, MediaFileFormatCode, MediaFileLink, MediaFileLinkTypeCode, MediaFileTypeCode, MessageNote, MessageNote, MessageNumber, MessageNumber, MessageRepeat, MessageRepeat, MinimumOrderQuantity, MinimumOrderQuantity, NameCodeType, NameCodeTypeName, NameCodeValue, NameIDType, NamesAfterKey, NamesAfterKey, NamesBeforeKey, NamesBeforeKey, NameType, NotificationType, NotificationType, Number, Number, NumberOfCopies, NumberOfIllustrations, NumberOfIllustrations, NumberOfItemsOfThisForm, NumberOfPages, NumberOfPages, NumberOfPieces, NumberWithinSeries, OccurrenceDateRole, OnHand, OnHand, OnOrder, OnOrder, OnSaleDate, OrderQuantityMinimum, OrderQuantityMultiple, OrderTime, OrderTime, OriginalLanguage, OriginalPublisher, OutOfPrintDate, PackQuantity, PackQuantity, PagesArabic, PagesRoman, PalletQuantity, PartNumber, Percent, Percent, PersonDateRole, PersonName, PersonName, PersonNameIDType, PersonNameInverted, PersonNameInverted, PersonNameType, PlaceAsSubject, PositionOnList, PositionOnProduct, PostalCode, PrefixToKey, PrefixToKey, PriceAmount, PriceAmount, PriceCode, PriceCodeType, PriceCodeTypeName, PriceConditionQuantityType, PriceConditionType, PriceConstraintStatus, PriceConstraintType, PriceConstraintUnit, PriceDateRole, PriceEffectiveFrom, PriceEffectiveUntil, PriceIDType, PricePartDescription, PricePer, PricePer, PriceQualifier, PriceQualifier, PriceStatus, PriceStatus, PriceType, PriceTypeCode, PriceTypeDescription, PriceTypeDescription, PrimaryContentType, PrintedOnProduct, PrizeCode, PrizeCode, PrizeCountry, PrizeCountry, PrizeIDType, PrizeJury, PrizeJury, PrizeName, PrizeName, PrizeRegion, PrizesDescription, PrizeStatement, PrizeYear, PrizeYear, ProductAvailability, ProductAvailability, ProductClassificationCode, ProductClassificationCode, ProductClassificationType, ProductClassificationType, ProductClassificationTypeName, ProductComposition, ProductContactIDType, ProductContactName, ProductContactRole, ProductContentType, ProductContentType, ProductForm, ProductForm, ProductFormDescription, ProductFormDescription, ProductFormDetail, ProductFormDetail, ProductFormFeatureDescription, ProductFormFeatureDescription, ProductFormFeatureType, ProductFormFeatureType, ProductFormFeatureValue, ProductFormFeatureValue, ProductIDType, ProductIDType, ProductPackaging, ProductPackaging, ProductRelationCode, ProductWebsiteDescription, ProductWebsiteLink, ProfessionalPosition, ProfessionalPosition, PromotionCampaign, PromotionCampaign, PromotionContact, Proximity, PublicationDate, PublisherIDType, PublisherName, PublisherName, PublisherNameInverted, PublisherProductNo, PublisherSeriesCode, PublishingDateRole, PublishingRole, PublishingRole, PublishingStatus, PublishingStatus, PublishingStatusNote, PublishingStatusNote, Quantity, QuantityUnit, Rate, Rating, RatingLimit, RatingUnits, RecordReference, RecordReference, RecordSourceIdentifier, RecordSourceIdentifierType, RecordSourceIDType, RecordSourceName, RecordSourceName, RecordSourceType, RecordSourceType, RegionCode, RegionCode, RegionsExcluded, RegionsIncluded, ReissueDate, ReissueDescription, RelationCode, ReligiousTextFeatureCode, ReligiousTextFeatureCode, ReligiousTextFeatureDescription, ReligiousTextFeatureDescription, ReligiousTextFeatureType, ReligiousTextFeatureType, ReligiousTextID, ReligiousTextIdentifier, ReplacedByEAN13, ReplacedByISBN, ReplacesEAN13, ReplacesISBN, ReprintDetail, ReprintDetail, Reserved, ResourceContentType, ResourceFeatureType, ResourceFileContentDescription, ResourceFileDateRole, ResourceFileDescription, ResourceFileDetail, ResourceFileFeatureDescription, ResourceFileFeatureType, ResourceFileFeatureValue, ResourceFileLink, ResourceForm, ResourceIDType, ResourceLink, ResourceMode, ResourceRole, ResourceVersionFeatureType, ReturnsCode, ReturnsCode, ReturnsCodeType, ReturnsCodeType, ReturnsCodeTypeName, ReturnsNote, ReviewQuote, RightsCountry, RightsRegion, RightsTerritory, ROWSalesRightsType, SalesOutletIDType, SalesOutletIDType, SalesOutletName, SalesOutletName, SalesRestrictionDetail, SalesRestrictionNote, SalesRestrictionType, SalesRestrictionType, SalesRightsType, SalesRightsType, ScriptCode, SenderIDType, SenderIDType, SenderName, SentDate, SentDateTime, SequenceNumber, SequenceNumber, SequenceNumberWithinRole, SeriesIDType, SeriesISSN, SeriesPartName, SetItemTitle, SetPartNumber, SetPartTitle, SourceName, SourceTitle, SourceType, SpecificationBundleNameTypeName, SpecificationBundleNameValue, SpecificationDescription, SpecificationDetail, SpecificationFeatureDescription, SpecificationFeatureType, SpecificationFeatureValue, SponsorName, StartDate, StartDate, StartTime, StockQuantityCode, StockQuantityCode, StockQuantityCodeType, StockQuantityCodeType, StockQuantityCodeTypeName, StockQuantityCodeTypeName, StreetAddress, StudyBibleType, StudyBibleType, SubjectCode, SubjectCode, SubjectDateRole, SubjectDescription, SubjectHeadingText, SubjectHeadingText, SubjectSchemeIdentifier, SubjectSchemeIdentifier, SubjectSchemeName, SubjectSchemeName, SubjectSchemeVersion, SubjectSchemeVersion, SubordinateEntries, Subtitle, Subtitle, SuffixToKey, SuffixToKey, SupplierCodeType, SupplierCodeTypeName, SupplierCodeValue, SupplierEANLocationNumber, SupplierIDType, SupplierIDType, SupplierName, SupplierName, SupplierRole, SupplierRole, SupplierSAN, SupplyContactIDType, SupplyContactName, SupplyContactRole, SupplyDateRole, SupplyRestrictionDetail, SupplyToCountry, SupplyToCountryExcluded, SupplyToRegion, SupplyToTerritory, TaxableAmount, TaxableAmount1, TaxableAmount2, TaxAmount, TaxAmount1, TaxAmount2, TaxRateCode, TaxRateCode1, TaxRateCode2, TaxRatePercent, TaxRatePercent1, TaxRatePercent2, TaxType, TelephoneNumber, TelephoneNumber, Territory, TerritoryExcluded, Text, Text, TextAuthor, TextAuthor, TextCaseFlag, TextFormat, TextItemIDType, TextItemIDType, TextItemType, TextItemType, TextLink, TextLinkType, TextPublicationDate, TextSourceCorporate, TextSourceCorporate, TextSourceDescription, TextSourceLink, TextSourceTitle, TextType, TextTypeCode, TextWithDownload, ThesisPresentedTo, ThesisPresentedTo, ThesisType, ThesisType, ThesisYear, ThesisYear, Thickness, TitleElementLevel, TitleOfSeries, TitleOfSet, TitlePrefix, TitlePrefix, TitlesAfterNames, TitlesAfterNames, TitlesBeforeNames, TitlesBeforeNames, TitleStatement, TitleText, TitleText, TitleType, TitleType, TitleWithoutPrefix, TitleWithoutPrefix, ToCompany, ToEANNumber, ToLanguage, ToPerson, ToQuantity, ToSAN, TradeAnnouncementDate, TradeCategory, TradeCategory, TranslationOfTitle, UnnamedPersons, UnnamedPersons, UnpricedItemType, UnpricedItemType, UPC, USSchoolGrade, VelocityMetric, VenueName, VenueNote, WebsiteDescription, WebsiteDescription, WebsiteLink, WebsiteLink, WebsiteRole, WebsiteRole, Weight, Width, WorkIDType, WorkIDType, WorkRelationCode, YearFirstPublished, YearOfAnnual, YearOfAnnual
public interface OnixElement<V> extends OnixTag
Fundamental interface in Jonix object model, representing an ONIX Element (i.e. an element that contains a single value field and possibly some attributes, but nothing else)

  • Method Summary

    Modifier and Type
    Method
    Description
    V
    __v()
     
    default boolean
    equal(V value)
    helper-method for fluent code, comparing the ONIX element's value with the given value, using equals() operation.
    default boolean
    is(V value)
    helper-method for fluent code, comparing the ONIX element's value with the given value, using identity (i.e.
    default boolean
    isNull()
    helper-method for fluent code, checking if the value is null, which could happen either if the element itself is missing (in which case exists() would be false), or if it's listed but has an empty or invalid value
    default Optional<V>
    value()
     

    Methods inherited from interface com.tectonica.jonix.common.OnixTag

    exists

  • Method Details

    • __v

      V __v()

    • value

      default Optional<V> value()
      Returns:
      an Optional wrapping the (single) value included in this object

    • isNull

      default boolean isNull()
      helper-method for fluent code, checking if the value is null, which could happen either if the element itself is missing (in which case exists() would be false), or if it's listed but has an empty or invalid value

    • is

      default boolean is(V value)
      helper-method for fluent code, comparing the ONIX element's value with the given value, using identity (i.e. ==) operator. This is particularly useful when the value is an OnixCodelist.

      The caller doesn't have to worry about the ONIX element's value being null (which could happen either if the element itself is missing (in which case exists() would be false), or if it's listed but has an empty or invalid value)

      Returns:
      true if the element's value == the passed value, false otherwise

    • equal

      default boolean equal(V value)
      helper-method for fluent code, comparing the ONIX element's value with the given value, using equals() operation. The caller doesn't have to worry about the ONIX element's value being null (which could happen either if the element itself is missing (in which case exists() would be false), or if it's listed but has an empty or invalid value)
      Returns:
      true if the element's value equals() to the passed value, false otherwise