Module jonix.common

Enum Class MeasureTypes

java.lang.Object
java.lang.Enum<MeasureTypes>
com.tectonica.jonix.common.codelist.MeasureTypes
All Implemented Interfaces:
OnixCodelist, Serializable, Comparable<MeasureTypes>, Constable

public enum MeasureTypes extends Enum<MeasureTypes> implements OnixCodelist
Enum that corresponds to ONIX Codelist 48

Description: Measure type

See Also:
  • Enum Constant Details

    • Height

      public static final MeasureTypes Height
      For a book, the overall height when standing on a shelf. For a folded map, the height when folded. For packaged products, the height of the retail packaging, and for trade-only products, the height of the trade packaging. In general, the height of a product in the form in which it is presented or packaged for retail sale
    • Width

      public static final MeasureTypes Width
      For a book, the overall horizontal dimension of the cover when standing upright. For a folded map, the width when folded. For packaged products, the width of the retail packaging, and for trade-only products, the width of the trade packaging. In general, the width of a product in the form in which it is presented or packaged for retail sale
    • Thickness

      public static final MeasureTypes Thickness
      For a book, the overall thickness of the spine. For a folded map, the thickness when folded. For packaged products, the depth of the retail packaging, and for trade-only products, the depth of the trade packaging. In general, the thickness or depth of a product in the form in which it is presented or packaged for retail sale
    • Page_trim_height

      public static final MeasureTypes Page_trim_height
      Overall height (code 01) is preferred for general use, as it includes the board overhang for hardbacks
    • Page_trim_width

      public static final MeasureTypes Page_trim_width
      Overall width (code 02) is preferred for general use, as it includes the board overhang and spine thickness for hardbacks
    • Unit_volume

      public static final MeasureTypes Unit_volume
      The volume of the product, including any retail packaging. Note the <MeasureUnit> is interpreted as a volumetric unit - for example code cm = cubic centimetres (ie millilitres), and code oz = (US) fluid ounces. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Unit_capacity

      public static final MeasureTypes Unit_capacity
      Volume of the internal (fluid) contents of a product (eg of paint in a can). Note the <MeasureUnit> is interpreted as a volumetric unit - for example code cm = cubic centimetres (ie millilitres), and code oz = (US) fluid ounces. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Unit_weight

      public static final MeasureTypes Unit_weight
      The overall weight of the product, including any retail packaging
    • Diameter_sphere

      public static final MeasureTypes Diameter_sphere
      Of a globe, for example
    • Unfolded_unrolled_sheet_height

      public static final MeasureTypes Unfolded_unrolled_sheet_height
      The height of a folded or rolled sheet map, poster etc when unfolded
    • Unfolded_unrolled_sheet_width

      public static final MeasureTypes Unfolded_unrolled_sheet_width
      The width of a folded or rolled sheet map, poster etc when unfolded
    • Diameter_tube_or_cylinder

      public static final MeasureTypes Diameter_tube_or_cylinder
      The diameter of the cross-section of a tube or cylinder, usually carrying a rolled sheet product. Use 01 'Height' for the height or length of the tube
    • Rolled_sheet_package_side_measure

      public static final MeasureTypes Rolled_sheet_package_side_measure
      The length of a side of the cross-section of a long triangular or square package, usually carrying a rolled sheet product. Use 01 'Height' for the height or length of the package
    • Unpackaged_height

      public static final MeasureTypes Unpackaged_height
      As height, but of the product without packaging (use only for products supplied in retail packaging, must also supply overall size when packaged using code 01). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Unpackaged_width

      public static final MeasureTypes Unpackaged_width
      As width, but of the product without packaging (use only for products supplied in retail packaging, must also supply overall size when packaged using code 02). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Unpackaged_thickness

      public static final MeasureTypes Unpackaged_thickness
      As thickness, but of the product without packaging (use only for products supplied in retail packaging, must also supply overall size when packaged using code 03). Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Total_battery_weight

      public static final MeasureTypes Total_battery_weight
      Weight of batteries built-in, pre-installed or supplied with the product. Details of the batteries should be provided using <ProductFormFeature>. A per-battery unit weight may be calculated from the number of batteries if required. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Total_weight_of_Lithium

      public static final MeasureTypes Total_weight_of_Lithium
      Mass or equivalent mass of elemental Lithium within the batteries built-in, pre-installed or supplied with the product (eg a Lithium Iron phosphate battery with 160g of cathode material would have a total of around 7g of Lithium). Details of the batteries must be provided using ProductFormFeature. A per-battery unit mass of Lithium may be calculated from the number of batteries if required. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Assembled_length

      public static final MeasureTypes Assembled_length
      For use where product or part of product requires assembly, for example the size of a completed kit, puzzle or assembled display piece. The assembled dimensions may be larger than the product size as supplied. Use only when the unassembled dimensions as supplied (including any retail or trade packaging) are also provided using codes 01, 02 and 03. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Assembled_width

      public static final MeasureTypes Assembled_width
      Jonix-Comment: Introduced in Onix3
    • Assembled_height

      public static final MeasureTypes Assembled_height
      Jonix-Comment: Introduced in Onix3
    • Unpackaged_unit_weight

      public static final MeasureTypes Unpackaged_unit_weight
      Overall unit weight (code 08) is preferred for general use, as it includes the weight of any packaging. Use Unpackaged unit weight only for products supplied in retail packaging, and must also supply overall unit weight. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Carton_length

      public static final MeasureTypes Carton_length
      Includes packaging. See <PackQuantity> for number of copies of the product per pack, and used only when dimensions of individual copies (codes 01, 02, 03) AND <PackQuantity> are supplied. Note that neither orders nor deliveries have to be aligned with multiples of the pack quantity, but such orders and deliveries may be more convenient to handle. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Carton_width

      public static final MeasureTypes Carton_width
      Jonix-Comment: Introduced in Onix3
    • Carton_height

      public static final MeasureTypes Carton_height
      Jonix-Comment: Introduced in Onix3
    • Carton_weight

      public static final MeasureTypes Carton_weight
      Includes the weight of product(s) within the carton. See <PackQuantity> for number of copies per pack, and used only when the weight of individual copies (code 08) AND <PackQuantity> are supplied. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Pallet_length

      public static final MeasureTypes Pallet_length
      Includes pallet and packaging. See <PalletQuantity> for number of copies of the product per pallet, and used only when dimensions of individual copies (codes 01, 02, 03) AND <PalletQuantity> are supplied. Note that neither orders nor deliveries have to be aligned with multiples of the pallet quantity, but such orders and deliveries may be more convenient to handle. Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

    • Pallet_width

      public static final MeasureTypes Pallet_width
      Jonix-Comment: Introduced in Onix3
    • Pallet_height

      public static final MeasureTypes Pallet_height
      Jonix-Comment: Introduced in Onix3
    • Pallet_weight

      public static final MeasureTypes Pallet_weight
      Includes the weight of product(s) and cartons stacked on the pallet. See <PalletQuantity> for the number of copies per pallet, and used only when the weight of individual copies (code 08) AND <PalletQuantity> are supplied.Only for use in ONIX 3.0 or later

      Jonix-Comment: Introduced in Onix3

  • Field Details

    • code

      public final String code
    • description

      public final String description
  • Method Details

    • values

      public static MeasureTypes[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static MeasureTypes valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getCode

      public String getCode()
      Specified by:
      getCode in interface OnixCodelist
    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface OnixCodelist
    • byCode

      public static MeasureTypes byCode(String code)
    • byCodeOptional

      public static Optional<MeasureTypes> byCodeOptional(String code)
    • codeToDesciption

      public static String codeToDesciption(String code)